cOutVector Class Reference
[Statistical data collection]
Responsible for recording vector simulation results (an output vector). More...
#include <coutvector.h>
Public Member Functions | |
Constructors, destructor, assignment | |
| cOutVector (const char *name=NULL) | |
| virtual | ~cOutVector () |
Redefined cObject member functions. | |
| virtual void | setName (const char *name) |
| virtual std::string | info () const |
| virtual void | parsimPack (cCommBuffer *buffer) |
| virtual void | parsimUnpack (cCommBuffer *buffer) |
Metadata annotations. | |
| virtual void | setEnum (const char *registeredEnumName) |
| virtual void | setEnum (cEnum *enumDecl) |
| virtual void | setUnit (const char *unit) |
| virtual void | setType (Type type) |
| virtual void | setInterpolationMode (InterpolationMode mode) |
| virtual void | setMin (double minValue) |
| virtual void | setMax (double maxValue) |
Writing to output vectors. | |
| virtual bool | record (double value) |
| virtual bool | record (SimTime value) |
| virtual bool | recordWithTimestamp (simtime_t t, double value) |
| virtual bool | recordWithTimestamp (simtime_t t, SimTime value) |
| virtual void | enable () |
| virtual void | disable () |
| virtual void | setEnabled (bool b) |
| virtual bool | isEnabled () const |
| virtual void | setRecordDuringWarmupPeriod (bool b) |
| virtual bool | getRecordDuringWarmupPeriod () const |
| long | getValuesReceived () const |
| long | getValuesStored () const |
Detailed Description
Responsible for recording vector simulation results (an output vector).
A cOutVector object can write doubles to the output vector file (or any another device determined by the current cOutputVectorManager).
Member Function Documentation
| virtual void cOutVector::disable | ( | ) | [inline, virtual] |
Disables recording data via this object.
record() methods will return false without doing anything.
| virtual void cOutVector::enable | ( | ) | [inline, virtual] |
Enables recording data via this object.
(It is enabled by default.)
| virtual bool cOutVector::getRecordDuringWarmupPeriod | ( | ) | const [inline, virtual] |
Returns true if the object will record data during the warm-up period.
- See also:
- cSimulation::getWarmupPeriod()
| long cOutVector::getValuesReceived | ( | ) | const [inline] |
| long cOutVector::getValuesStored | ( | ) | const [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.
| virtual std::string cOutVector::info | ( | ) | const [virtual] |
| virtual void cOutVector::parsimPack | ( | cCommBuffer * | buffer | ) | [virtual] |
Packing and unpacking cannot be supported with this class.
This methods raises an error.
Reimplemented from cNoncopyableOwnedObject.
| virtual void cOutVector::parsimUnpack | ( | cCommBuffer * | buffer | ) | [virtual] |
Packing and unpacking cannot be supported with this class.
This methods raises an error.
Reimplemented from cNoncopyableOwnedObject.
| virtual bool cOutVector::record | ( | double | value | ) | [virtual] |
Records the value with the current simulation time as timestamp.
The return value is true if the data was actually recorded, and false if it was not recorded (because of filtering, etc.)
| virtual bool cOutVector::recordWithTimestamp | ( | simtime_t | t, | |
| double | value | |||
| ) | [virtual] |
Records the value with the given time as timestamp.
Values must be recorded in increasing timestamp order, that is, it is not possible to record a value with a timestamp that is less than that of the last recorded value.
The return value is true if the data was actually recorded, and false if it was not recorded (because of filtering, etc.)
| virtual void cOutVector::setEnabled | ( | bool | b | ) | [inline, virtual] |
| virtual void cOutVector::setEnum | ( | cEnum * | enumDecl | ) | [virtual] |
Associate the vector with an enum.
The enum name as well as the symbols and their integer values will get recorded into the output vector file, and may be used by result analysis tools. cOutVector does not verify that recorded values actually comply with this annotation.
| virtual void cOutVector::setEnum | ( | const char * | registeredEnumName | ) | [virtual] |
Associate the vector with an enum defined in a msg file.
This information gets recorded into the output vector file and may be used by result analysis tools. cOutVector does not verify that recorded values actually comply with this annotation.
| virtual void cOutVector::setInterpolationMode | ( | InterpolationMode | mode | ) | [virtual] |
Annotate the vector with an interpolation mode.
This information gets recorded into the output vector file, and may be used by result analysis tools as a hint for choosing a plotting style.
| virtual void cOutVector::setMax | ( | double | maxValue | ) | [virtual] |
Annotate the vector with a maximum value.
This information gets recorded into the output vector file and may be used by result analysis tools. cOutVector does not verify that recorded values actually comply with this annotation.
| virtual void cOutVector::setMin | ( | double | minValue | ) | [virtual] |
Annotate the vector with a minimum value.
This information gets recorded into the output vector file and may be used by result analysis tools. cOutVector does not verify that recorded values actually comply with this annotation.
| virtual 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 cNamedObject.
| virtual void cOutVector::setRecordDuringWarmupPeriod | ( | bool | b | ) | [inline, virtual] |
Enables/disables recording data during the warm-up period.
When set to false, record() calls will be ignored during warm-up period.
- See also:
- cSimulation::getWarmupPeriod()
| virtual void cOutVector::setType | ( | Type | type | ) | [virtual] |
Annotate the vector with a data type.
This information gets recorded into the output vector file, and may be used by result analysis tools. cOutVector does not verify that recorded values actually comply with this annotation.
| virtual void cOutVector::setUnit | ( | const char * | unit | ) | [virtual] |
Annotate the vector with a physical unit (like "s", "mW" or "bytes").
This information gets recorded into the output vector file, and may be used by result analysis tools.
The documentation for this class was generated from the following file:
