envirext.h

//==========================================================================
//  ENVIREXT.H - part of
//                     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_ENVIREXT_H
#define __OMNETPP_ENVIREXT_H
 
#include <iostream>
#include "simkerneldefs.h"
#include "opp_string.h"
#include "simtime_t.h"
#include "cobject.h"
#include "simtime_t.h"
#include "opp_string.h"
#include "clifecyclelistener.h"
 
namespace omnetpp {
 
class cModule;
class cStatistic;
class cEvent;
class cMessage;
class cGate;
struct SendOptions;
struct ChannelResult;
 
class SIM_API cIOutputVectorManager : public cObject, public cISimulationLifecycleListener, noncopyable
{
  protected:
    virtual void lifecycleEvent(SimulationLifecycleEventType eventType, cObject *details) override;
 
  public:
 
    explicit cIOutputVectorManager() {}
 
    virtual ~cIOutputVectorManager() {}
 
 
    virtual void startRun() = 0;
 
    virtual void endRun() = 0;
 
 
    virtual void *registerVector(const char *modulename, const char *vectorname) = 0;
 
    virtual void deregisterVector(void *vechandle) = 0;
 
    virtual void setVectorAttribute(void *vechandle, const char *name, const char *value) = 0;
 
    virtual bool record(void *vechandle, simtime_t t, double value) = 0;
 
    virtual const char *getFileName() const = 0;
 
    virtual void flush() = 0;
};
 
 
class SIM_API cIOutputScalarManager : public cObject, public cISimulationLifecycleListener, noncopyable
{
  protected:
    virtual void lifecycleEvent(SimulationLifecycleEventType eventType, cObject *details) override;
 
  public:
 
    explicit cIOutputScalarManager() {}
 
    virtual ~cIOutputScalarManager() {}
 
 
    virtual void startRun() = 0;
 
    virtual void endRun() = 0;
 
 
    virtual bool recordScalar(cComponent *component, const char *name, double value, opp_string_map *attributes=nullptr) = 0;
 
    virtual bool recordStatistic(cComponent *component, const char *name, cStatistic *statistic, opp_string_map *attributes=nullptr) = 0;
 
    virtual bool recordParameter(cPar *par) = 0;
 
    virtual bool recordComponentType(cComponent *component) = 0;
 
    virtual const char *getFileName() const = 0;
 
    virtual void flush() = 0;
};
 
 
class SIM_API cISnapshotManager : public cObject, public cISimulationLifecycleListener, noncopyable
{
  protected:
    virtual void lifecycleEvent(SimulationLifecycleEventType eventType, cObject *details) override;
 
  public:
 
    explicit cISnapshotManager() {}
 
    virtual ~cISnapshotManager() {}
 
 
    virtual void startRun() = 0;
 
    virtual void endRun() = 0;
 
    virtual std::ostream *getStreamForSnapshot() = 0;
 
    virtual void releaseStreamForSnapshot(std::ostream *os) = 0;
 
    virtual const char *getFileName() const = 0;
};
 
 
class SIM_API cIEventlogManager : public cObject, noncopyable
{
  public:
 
    explicit cIEventlogManager() {}
 
    virtual ~cIEventlogManager() {}
 
 
    virtual void resume() = 0;
 
    virtual void suspend() = 0;
 
    virtual void flush() = 0;
 
    virtual const char *getFileName() const = 0;
 
    //TODO this one could be removed from the interface by invoking it via the LF_ON_RUN_END lifecycle event, but it needs to send more details
    virtual void endRun(bool isError, int resultCode, const char *message) = 0;
 
    virtual void simulationEvent(cEvent *event) = 0;
    virtual void bubble(cComponent *component, const char *text) = 0;
    virtual void messageScheduled(cMessage *msg) = 0;
    virtual void messageCancelled(cMessage *msg) = 0;
    virtual void beginSend(cMessage *msg, const SendOptions& options) = 0;
    virtual void messageSendDirect(cMessage *msg, cGate *toGate, const ChannelResult& result) = 0;
    virtual void messageSendHop(cMessage *msg, cGate *srcGate) = 0;
    virtual void messageSendHop(cMessage *msg, cGate *srcGate, const ChannelResult& result) = 0;
    virtual void endSend(cMessage *msg) = 0;
    virtual void messageCreated(cMessage *msg) = 0;
    virtual void messageCloned(cMessage *msg, cMessage *clone) = 0;
    virtual void messageDeleted(cMessage *msg) = 0;
    virtual void moduleReparented(cModule *module, cModule *oldparent, int oldId) = 0;
    virtual void componentMethodBegin(cComponent *from, cComponent *to, const char *methodFmt, va_list va) = 0;
    virtual void componentMethodEnd() = 0;
    virtual void moduleCreated(cModule *newmodule) = 0;
    virtual void moduleDeleted(cModule *module) = 0;
    virtual void gateCreated(cGate *newgate) = 0;
    virtual void gateDeleted(cGate *gate) = 0;
    virtual void connectionCreated(cGate *srcgate) = 0;
    virtual void connectionDeleted(cGate *srcgate) = 0;
    virtual void displayStringChanged(cComponent *component) = 0;
    virtual void logLine(const char *prefix, const char *line, int lineLength) = 0;
    virtual void stoppedWithException(bool isError, int resultCode, const char *message) = 0;
};
 
}  // namespace omnetpp
 
 
#endif