clifecyclelistener.h

//==========================================================================
//   CLIFECYCLELISTENER.H  -  header for
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//==========================================================================
 
/*--------------------------------------------------------------*
  Copyright (C) 1992-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_CLIFECYCLELISTENER_H
#define __OMNETPP_CLIFECYCLELISTENER_H
 
#include "cobject.h"
 
namespace omnetpp {
 
enum SimulationLifecycleEventType
{
    LF_ON_STARTUP,
 
    LF_PRE_NETWORK_SETUP,
 
    LF_POST_NETWORK_SETUP,
 
    LF_PRE_NETWORK_INITIALIZE,
 
    LF_POST_NETWORK_INITIALIZE,
 
    LF_ON_SIMULATION_START,
 
    LF_ON_SIMULATION_PAUSE,
 
    LF_ON_SIMULATION_RESUME,
 
    LF_ON_SIMULATION_SUCCESS,
 
    //TODO the detail object should contain the exception object
    LF_ON_SIMULATION_ERROR,
 
    LF_PRE_NETWORK_FINISH,
 
    LF_POST_NETWORK_FINISH,
 
    LF_ON_RUN_END,
 
    LF_PRE_NETWORK_DELETE,
 
    LF_POST_NETWORK_DELETE,
 
    LF_ON_SHUTDOWN,
};
 
 
class SIM_API cISimulationLifecycleListener
{
  public:
    virtual ~cISimulationLifecycleListener();
 
    virtual void lifecycleEvent(SimulationLifecycleEventType eventType, cObject *details) = 0;
 
    virtual void listenerAdded() {}
 
    virtual void listenerRemoved() {}
 
    static const char *getSimulationLifecycleEventName(SimulationLifecycleEventType eventType);
};
 
}  // namespace omnetpp
 
#endif