gadget2/reference/actionattimes_8h_source.html

 #ifndef actionattimes_h

 #define actionattimes_h


 #include "commentstream.h"

 #include "areatime.h"

 #include "intvector.h"


 class ActionAtTimes {

 public:

   ActionAtTimes() { everyStep = 0; };

   ~ActionAtTimes() {};

   int readFromFile(CommentStream& infile, const TimeClass* const TimeInfo);

   void addActions(const IntVector& years, const IntVector& steps, const TimeClass* const TimeInfo);

   void addActionsAllYears(const IntVector& steps, const TimeClass* const TimeInfo);

   void addActionsAllSteps(const IntVector& years, const TimeClass* const TimeInfo);

   int atCurrentTime(const TimeClass* const TimeInfo) const;

 protected:

   int everyStep;

   IntVector TimeSteps;

   IntVector Years;

   IntVector Steps;

 };


 #endif

areatime.h

ActionAtTimes
This is the class used to associate actions with specific timesteps within the model.
Definition: actionattimes.h:14

ActionAtTimes::addActionsAllYears
void addActionsAllYears(const IntVector &steps, const TimeClass *const TimeInfo)
This is the function used to add the action on all years for a set of steps.
Definition: actionattimes.cc:95

ActionAtTimes::Steps
IntVector Steps
This is the IntVector of the steps on which the action takes place.
Definition: actionattimes.h:72

ActionAtTimes::TimeSteps
IntVector TimeSteps
This is the IntVector of the timesteps on which the action takes place.
Definition: actionattimes.h:64

ActionAtTimes::addActionsAllSteps
void addActionsAllSteps(const IntVector &years, const TimeClass *const TimeInfo)
This is the function used to add the action on all steps for a set of years.
Definition: actionattimes.cc:106

ActionAtTimes::atCurrentTime
int atCurrentTime(const TimeClass *const TimeInfo) const
This is the function used to check whether an action takes place on the current timestep.
Definition: actionattimes.cc:121

ActionAtTimes::readFromFile
int readFromFile(CommentStream &infile, const TimeClass *const TimeInfo)
This is the function used to read in the action at times parameters.
Definition: actionattimes.cc:7

ActionAtTimes::~ActionAtTimes
~ActionAtTimes()
This is the ActionAtTimes destructor.
Definition: actionattimes.h:23

ActionAtTimes::Years
IntVector Years
This is the IntVector of the years on which the action takes place.
Definition: actionattimes.h:68

ActionAtTimes::ActionAtTimes
ActionAtTimes()
This is the ActionAtTimes constructor.
Definition: actionattimes.h:19

ActionAtTimes::everyStep
int everyStep
This is the flag if the action takes place on every timestep.
Definition: actionattimes.h:60

ActionAtTimes::addActions
void addActions(const IntVector &years, const IntVector &steps, const TimeClass *const TimeInfo)
This is the function used to add the action for a set of steps and years.
Definition: actionattimes.cc:82

CommentStream
This is the class used to strip comments (and whitespace) from any input stream.
Definition: commentstream.h:40

IntVector
This class implements a dynamic vector of int values.
Definition: intvector.h:11

TimeClass
This is the class used to store information about the timesteps used for the current model.
Definition: areatime.h:87

commentstream.h

intvector.h