envirext.h

//==========================================================================
//  ENVIREXT.H - part of
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//
//  Declaration of the following classes:
//    cOutputVectorManager  : actually records for cOutVector objects
//
//==========================================================================

/*--------------------------------------------------------------*
  Copyright (C) 1992-2008 Andras Varga
  Copyright (C) 2006-2008 OpenSim Ltd.

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

#ifndef __ENVIREXT_H
#define __ENVIREXT_H

#include <iostream>
#include "simkerneldefs.h"
#include "cobject.h"

NAMESPACE_BEGIN


class cModule;
class cStatistic;

class SIM_API cOutputVectorManager : public cObject
{
  private:
    // copy constructor and assignment unsupported, make them inaccessible and also leave unimplemented
    cOutputVectorManager(const cOutputVectorManager&);
    cOutputVectorManager& operator=(const cOutputVectorManager&);

  public:

    explicit cOutputVectorManager() {}

    virtual ~cOutputVectorManager() {}


    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 cOutputScalarManager : public cObject
{
  private:
    // copy constructor and assignment unsupported, make them inaccessible and also leave unimplemented
    cOutputScalarManager(const cOutputScalarManager&);
    cOutputScalarManager& operator=(const cOutputScalarManager&);

  public:

    explicit cOutputScalarManager() {}

    virtual ~cOutputScalarManager() {}


    virtual void startRun() = 0;

    virtual void endRun() = 0;


    virtual void recordScalar(cComponent *component, const char *name, double value, opp_string_map *attributes=NULL) = 0;

    virtual void recordStatistic(cComponent *component, const char *name, cStatistic *statistic, opp_string_map *attributes=NULL) = 0;

    virtual const char *getFileName() const = 0;

    virtual void flush() = 0;
};


class SIM_API cSnapshotManager : public cObject
{
  private:
    // copy constructor and assignment unsupported, make them inaccessible and also leave unimplemented
    cSnapshotManager(const cSnapshotManager&);
    cSnapshotManager& operator=(const cSnapshotManager&);

  public:

    explicit cSnapshotManager() {}

    virtual ~cSnapshotManager() {}


    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;
};

NAMESPACE_END


#endif