Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members  

cOutVector Class Reference

#include <coutvect.h>

Inheritance diagram for cOutVector::

cObject List of all members.

Public Methods

Constructors, destructor, assignment
 cOutVector (const char *name=NULL, int tuple=1)
 cOutVector (const cOutVector &r)
virtual ~cOutVector ()
cOutVector& operator= (const cOutVector &)
Redefined cObject member functions.
virtual void setName (const char *name)
virtual const char* className () const
virtual cObjectdup () const
virtual void info (char *buf)
virtual const char* inspectorFactoryName () const
Configuring and writing to output vectors.
virtual bool record (double value)
virtual bool record (double value1, double value2)
virtual void enable ()
virtual void disable ()
virtual bool isEnabled ()
long valuesReceived ()
long valuesStored ()

Detailed Description

Responsible for recording vector simuotation results (an output vector). A cOutVector object can write doubles to the output vector file (or any another device determined by the current cOutputVectorManager).


Constructor & Destructor Documentation

cOutVector::cOutVector ( const char * name = NULL,
int tuple = 1 ) [explicit]
 

Constructor. Accepts the object name. The second argument can be 1 or 2.

cOutVector::cOutVector ( const cOutVector & r ) [inline]
 

Copy constructor.

cOutVector::~cOutVector ( ) [virtual]
 

Destructor.


Member Function Documentation

const char * cOutVector::className ( ) const [inline, virtual]
 

Returns pointer to a string containing the class name, "cOutVector".

Reimplemented from cObject.

void cOutVector::disable ( ) [inline, virtual]
 

Disables recording data via this object. record() methods will return false without doing anything.

cObject * cOutVector::dup ( ) const [inline, virtual]
 

Dupping is not implemented for cOutVector. This function gives an error when called.

Reimplemented from cObject.

void cOutVector::enable ( ) [inline, virtual]
 

Enables recording data via this object. (It is enabled by default.)

void cOutVector::info ( char * buf ) [virtual]
 

Produces a one-line description of object contents into the buffer passed as argument. See cObject for more details.

Reimplemented from cObject.

const char * cOutVector::inspectorFactoryName ( ) const [inline, virtual]
 

Returns the name of the inspector factory class associated with this class. See cObject for more details.

Reimplemented from cObject.

bool cOutVector::isEnabled ( ) [inline, virtual]
 

Returns true if recording the data is enabled, false otherwise.

cOutVector & cOutVector::operator= ( const cOutVector & ) [inline]
 

Assignment is not supported for this class. This function raises an error when called.

bool cOutVector::record ( double value1,
double value2 ) [virtual]
 

Records two values with the current simulation time as timestamp. It can be used only in the case if the instance of cOutVector was created with tuple=2, otherwise it gives an error message.

The return value is true if the data was actually recorded, and false if it was not recorded (because of filtering, etc.)

bool cOutVector::record ( double value ) [virtual]
 

Records the value with the current simulation time as timestamp. It can be used only in the case if the instance of cOutVector was created with tuple=1, otherwise it gives an error message.

The return value is true if the data was actually recorded, and false if it was not recorded (because of filtering, etc.)

void cOutVector::setName ( const char * name ) [virtual]
 

Sets the name of the object. It is not possible to call this method after the first call to record().

Reimplemented from cObject.

long cOutVector::valuesReceived ( ) [inline]
 

Returns the total number of values passed to the record() method of this output vector object. This includes the values passed while the object was disabled (see disable()).

long cOutVector::valuesStored ( ) [inline]
 

Returns the number of values actually stored by this output vector object. The values passed while the object was disabled (via disable(), environment configuration, filtering, etc.) do not count.


The documentation for this class was generated from the following file:
Generated at Sat May 4 15:45:50 2002 for OMNeT++ by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001