trick/trick_source/sim_services/MonteCarlo/include/MonteVar.hh
Alex Lin 14a75508a3 Cleaning up once include variables and copyright cleanup.
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.
2015-03-23 16:03:14 -05:00

56 lines
1.2 KiB
C++

/*
PURPOSE: (Monte carlo structures)
REFERENCE: (Trick Users Guide)
ASSUMPTIONS AND LIMITATIONS: (None)
PROGRAMMERS: ((Keith Vetter) (LinCom) (7/2003))
*/
#ifndef MONTEVAR_HH
#define MONTEVAR_HH
#include <string>
namespace Trick {
/**
* Abstract base class for Monte Carlo variables.
*
* @author Alex Lin
* @author Donna Panter
* @author Derek Bankieris
*
* @date August 2010
*/
class MonteVar {
public:
/** Name. */
std::string name; /**< \n trick_units(--) */
/** Units. */
std::string unit; /**< \n trick_units(--) */
/** Value. */
std::string value; /**< \n trick_units(--) */
/** Destructor. */
virtual ~MonteVar() {};
/** Class MonteCarlo is a friend so it can use the get_next_value method.
* The get_next_value method needs to be protected so users cannot use it in the input file
*/
friend class MonteCarlo ;
protected:
/**
* Gets this variable's next value.
*
* @return the next value
*/
virtual std::string get_next_value() = 0;
};
};
#endif