cscheduler.h

//=========================================================================
//  CSCHEDULER.H - part of
//                  OMNeT++/OMNEST
//           Discrete System Simulation in C++
//
//=========================================================================

/*--------------------------------------------------------------*
  Copyright (C) 2003-2017 Andras Varga
  Copyright (C) 2006-2017 OpenSim Ltd.

  This file is distributed WITHOUT ANY WARRANTY. See the file
  `license' for details on this and other legal matters.
*--------------------------------------------------------------*/

#ifndef __OMNETPP_CSCHEDULER_H
#define __OMNETPP_CSCHEDULER_H

#include "cobject.h"
#include "simtime_t.h"
#include "clifecyclelistener.h"

namespace omnetpp {

class cEvent;
class cSimulation;

class SIM_API cScheduler : public cObject, public cISimulationLifecycleListener
{
  protected:
    cSimulation *sim;

  protected:
    virtual void lifecycleEvent(SimulationLifecycleEventType eventType, cObject *details) override;

  public:
    cScheduler();

    virtual ~cScheduler();

    virtual std::string str() const override;

    virtual void setSimulation(cSimulation *_sim);

    cSimulation *getSimulation() const {return sim;}

    virtual void startRun() {}

    virtual void endRun() {}

    virtual void executionResumed() {}

    virtual cEvent *guessNextEvent() = 0;

    virtual cEvent *takeNextEvent() = 0;

    virtual void putBackEvent(cEvent *event) = 0;
};


class SIM_API cSequentialScheduler : public cScheduler
{
  public:
    cSequentialScheduler() {}

    virtual std::string str() const override;

    virtual cEvent *guessNextEvent() override;

    virtual cEvent *takeNextEvent() override;

    virtual void putBackEvent(cEvent *event) override;
};


//TODO soft realtime, hard realtime (that is: tries to catch up, or resynchronizes on each event)
class SIM_API cRealTimeScheduler : public cScheduler
{
  protected:
    // configuration:
    bool doScaling;
    double factor;

    // state:
    int64_t baseTime;  // in microseconds

  protected:
    virtual void startRun() override;
    bool waitUntil(int64_t targetTime); // in microseconds
    int64_t toUsecs(simtime_t t);

  public:
    cRealTimeScheduler();

    virtual ~cRealTimeScheduler();

    virtual std::string str() const override;

    virtual void executionResumed() override;

    virtual cEvent *guessNextEvent() override;

    virtual cEvent *takeNextEvent() override;

    virtual void putBackEvent(cEvent *event) override;
};

}  // namespace omnetpp


#endif