mirror of
https://github.com/nasa/trick.git
synced 2025-01-25 05:46:58 +00:00
14a75508a3
Changed all header file once include variables to follow the same naming convention and not start with any underscores. Also deleted old incorrect copyright notices. Also removed $Id: tags from all files. Fixes #14. Fixes #22.
52 lines
1.6 KiB
C++
52 lines
1.6 KiB
C++
/*
|
|
PURPOSE: (Monte carlo structures)
|
|
REFERENCE: (Trick Users Guide)
|
|
ASSUMPTIONS AND LIMITATIONS: (None)
|
|
PROGRAMMERS: ((Keith Vetter) (LinCom) (7/2003))
|
|
*/
|
|
|
|
#ifndef MONTEVARCALCULATED_HH
|
|
#define MONTEVARCALCULATED_HH
|
|
|
|
#include <string>
|
|
|
|
#include "MonteVar.hh"
|
|
#include "sim_services/MemoryManager/include/reference.h"
|
|
|
|
namespace Trick {
|
|
|
|
/**
|
|
* A variable whose values are calculated by the user. This class is meant to provide the user with a way to fine tune
|
|
* a Monte Carlo's progression, using results from previous runs to influence the values used in future runs. The value
|
|
* is taken from a simulation variable named by the user. The proper way to update that reference variable is to change
|
|
* its value in a Trick job of type <code>"monte_master_pre"</code> or <code>"monte_master_post"</code>.
|
|
*
|
|
* @author Alex Lin
|
|
* @author Donna Panter
|
|
* @author Derek Bankieris
|
|
*
|
|
* @date August 2010
|
|
*/
|
|
class MonteVarCalculated : public Trick::MonteVar {
|
|
|
|
protected:
|
|
/** Reference. */
|
|
REF2 * ref2; /**< \n trick_units(--) */
|
|
|
|
public:
|
|
/**
|
|
* Constructs a MonteVarCalculated with the specified name and units.
|
|
*
|
|
* @param name the fully qualified name of the simulation variable to which this MonteVarCalculated refers
|
|
* @param unit this variable's units
|
|
*/
|
|
MonteVarCalculated(std::string name, std::string unit = "");
|
|
|
|
protected:
|
|
virtual std::string get_next_value();
|
|
|
|
};
|
|
|
|
};
|
|
#endif
|