Main Page Modules Class Hierarchy Compound List File List Compound Members

# cOutputVectorManager Class Reference

`#include <envirext.h>`

List of all members.

## Public Methods

Constructor, destructor
| cOutputVectorManager ()
virtual | ~cOutputVectorManager ()
Controlling the beginning and end of collecting data.
virtual void | startRun ()=0
virtual void | endRun ()=0
Output vectors.
virtual void* | registerVector (const char *modulename, const char *vectorname, int tuple)=0
virtual void | deregisterVector (void *vechandle)=0
virtual bool | record (void *vechandle, simtime_t t, double value)=0
virtual bool | record (void *vechandle, simtime_t t, double value1, double value2)=0
virtual const char* | fileName () const=0

## Detailed Description

Abstract class. cOutputVectorManagers are plugins into the Envir user interface library (src/envir) that handle recording the output for cOutVectors.

The default output vector manager is cFileOutputVectorManager, defined in the Envir library.

## Constructor & Destructor Documentation

cOutputVectorManager::cOutputVectorManager ( | )`[inline, explicit]`

| Constructor.

cOutputVectorManager::~cOutputVectorManager ( | )`[inline, virtual]`

| Destructor.

## Member Function Documentation

void cOutputVectorManager::deregisterVector ( | void * vechandle )`[pure virtual]`

| This method is called internally by the Envir library when a cOutVector object deregisters itself.

void cOutputVectorManager::endRun ( | )`[pure virtual]`

| Closes collecting. Called at the end of a simulation run.

const char * cOutputVectorManager::fileName ( | ) const`[pure virtual]`

| Returns the output vector file name. Returns NULL if this object is not working into a file output.

bool cOutputVectorManager::record ( | void * vechandle,
| simtime_t t,
| double value1,
| double value2 )`[pure virtual]`

| This method is called internally by the Envir library when a cOutVector object writes a value pair into the output vector. The return value should be true if the data was actually recorded, and false if it was not recorded (because of filtering, etc.)

bool cOutputVectorManager::record ( | void * vechandle,
| simtime_t t,
| double value )`[pure virtual]`

| This method is called internally by the Envir library when a cOutVector object writes a value into the output vector. The return value should be true if the data was actually recorded, and false if it was not recorded (because of filtering, etc.)

void * cOutputVectorManager::registerVector ( | const char * modulename,
| const char * vectorname,
| int tuple )`[pure virtual]`

| This method is called internally by the Envir library when a cOutVector object registers itself. The return value is a handle of type void*; this handle is passed to record() to identify the vector.

void cOutputVectorManager::startRun ( | )`[pure virtual]`

| Opens collecting. Called at the beginning of a simulation run.

The documentation for this class was generated from the following file:

- envirext.h