trick/include/trick/MonteVarCalculated.hh
Alex Lin 19025d77ad Standardize directory names
Reorganized.  Created a new top level include directory that will hold all of Trick's header files. Moved all of the Trick headers to this directory.  Created a libexec directory that holds all of the executables that users don't need to execute directly.  Changed all of the executables remaining in bin to start with "trick-".  In the sim_services directories changed all source files to find the Trick headers in their new location.  Since all of the include files are gone in sim_services, removed the src directories as well, moving all of the source files up a level.  Moved the makefiles, docs, man, and other architecture independent files into a top level share directory.  Renamed lib_${TRICK_HOST_CPU} to lib64 or lib depending on the platform we're currently on.

refs #63
2015-06-09 08:44:42 -05:00

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 "trick/MonteVar.hh"
#include "trick/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