populationalgorithmsimple.h

Go to the documentation of this file.

#ifndef POPULATIONALGORITHMSIMPLE_H

#define POPULATIONALGORITHMSIMPLE_H

#include "simplealgorithm.h"
#include "populationinterfaces.h"
#include "populationevent.h"
#include <assert.h>

class GslRandomNumberGenerator;
class PersonBase;
class PopulationEvent;
class PopulationStateSimple;

class PopulationAlgorithmSimple : public SimpleAlgorithm, public PopulationAlgorithmInterface
{
public:
        PopulationAlgorithmSimple(PopulationStateSimple &state, GslRandomNumberGenerator &rng, bool parallel);
        ~PopulationAlgorithmSimple();

        bool_t init();
        bool_t run(double &tMax, int64_t &maxEvents, double startTime = 0);
        void onNewEvent(PopulationEvent *pEvt);

        // TODO: shield these from the user somehow? These functions should not be used
        //       directly by the user, they are used internally by the algorithm
        void scheduleForRemoval(PopulationEvent *pEvt);

        double getTime() const                                                                                                                  { return SimpleAlgorithm::getTime(); }

        void setAboutToFireAction(PopulationAlgorithmAboutToFireInterface *pAction)             { m_pOnAboutToFire = pAction; }
        GslRandomNumberGenerator *getRandomNumberGenerator() const                                              { return SimpleAlgorithm::getRandomNumberGenerator(); }
private:
        bool_t initEventTimes() const;
        const std::vector<EventBase *> &getCurrentEvents() const                                        { return m_allEvents; }
        void onFiredEvent(EventBase *pEvt, int position);
        int64_t getNextEventID();
        void onAboutToFire(EventBase *pEvt)                                                                                             { if (m_pOnAboutToFire) m_pOnAboutToFire->onAboutToFire(static_cast<PopulationEvent *>(pEvt)); }

        std::vector<EventBase *> m_allEvents;
        PopulationStateSimple &m_popState;
        bool m_init;

#ifdef STATE_SHOW_EVENTS
        void showEvents(); // FOR DEBUGGING
#endif // STATE_SHOW_EVENTS
        void onAlgorithmLoop();

        std::vector<EventBase *> m_eventsToRemove;

        // For the parallel version
        bool m_parallelRequested;
        int64_t m_nextEventID;

        PopulationAlgorithmAboutToFireInterface *m_pOnAboutToFire;
};

inline int64_t PopulationAlgorithmSimple::getNextEventID()
{
        int64_t id = m_nextEventID++;
        return id;
}

#endif // POPULATIONALGORITHMSIMPLE_H