gadget2/reference/livesonareas_8h_source.html

 #ifndef livesonareas_h

 #define livesonareas_h


 #include "intvector.h"


 class LivesOnAreas {

 public:

   LivesOnAreas() {};

   virtual ~LivesOnAreas() {};

   LivesOnAreas(const IntVector& Areas);

   int isInArea(int area) const;

   IntVector& getAreas() { return areas; };

   int areaNum(int area) const;

 protected:

   void storeAreas(const IntVector& Areas);

   IntVector areas;

 private:

   IntVector areaConvert;

 };


 #endif

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

LivesOnAreas
This is the class used to store information about the areas an object is defined on for the current m...
Definition: livesonareas.h:10

LivesOnAreas::areas
IntVector areas
This is the IntVector of internal areas that the object is defined on.
Definition: livesonareas.h:51

LivesOnAreas::~LivesOnAreas
virtual ~LivesOnAreas()
This is the default LivesOnAreas destructor.
Definition: livesonareas.h:19

LivesOnAreas::isInArea
int isInArea(int area) const
This function will check whether the object is defined on a specified area.
Definition: livesonareas.cc:27

LivesOnAreas::storeAreas
void storeAreas(const IntVector &Areas)
This function will store the internal areas to be used.
Definition: livesonareas.cc:39

LivesOnAreas::LivesOnAreas
LivesOnAreas()
This is the default LivesOnAreas constructor.
Definition: livesonareas.h:15

LivesOnAreas::getAreas
IntVector & getAreas()
This function will return the internal areas that the object is defined on.
Definition: livesonareas.h:35

LivesOnAreas::areaNum
int areaNum(int area) const
This function will return the area associated with an internal area.
Definition: livesonareas.cc:33

intvector.h