DtStandardVariableRecordSet Class Reference

Inheritance diagram for DtStandardVariableRecordSet:

Collaboration diagram for DtStandardVariableRecordSet:

Public Member Functions
	DtStandardVariableRecordSet ()
	Constructor.
	DtStandardVariableRecordSet (const DtStandardVariableRecordSet &orig)
	Copy Constructor.
virtual	~DtStandardVariableRecordSet ()
	Destructor.
virtual DtStandardVariableRecordSet &	operator= (const DtStandardVariableRecordSet &rhs)
	Assignment operator.
virtual unsigned int	numberOfRecords () const
	Returns number of records.
virtual void	printRecords () const
	Prints the data to DtInfo.
virtual void	printRecordsToStream (std::ostream &stream) const
	Prints the data to the specified stream.
virtual void	addRecord (std::auto_ptr< DtStandardVariableRecord > record)
	Adds a record.
virtual void	addRecords (const DtStandardVariableRecordPtrVector &records)
	Adds the given records.
virtual void	removeRecordByIndex (unsigned int index)
	Remove the record at the given index.
virtual int	removeRecordByType (unsigned int recordType, bool removeAll=true)
	Remove and discard the first record of the given record type (if there is one) or all them.
virtual DtStandardVariableRecord *	recordByIndex (unsigned int index) const
	Returns the record with the given index.
virtual DtStandardVariableRecord *	recordByType (unsigned int recordType) const
	Returns the record with the given type (first one if more than one).
virtual const DtStandardVariableRecordPtrVector &	records () const
	Returns the vector of records.
virtual DtStandardVariableRecordPtrVector &	getRecords (unsigned int recordType, DtStandardVariableRecordPtrVector &recordsOfType) const
	Get the vector of records of the given type Any changes to these records will modify the records in the recordSet.
virtual DtStandardVariableRecordPtrVector &	getRecords (DtStandardVariableRecordPtrVector &records) const
	Get the vector of records Any changes to this record will modify the record in the recordSet.
virtual void	clearRecords ()
	Clear all records.
virtual std::vector< unsigned int >	recordTypes () const
	Returns a vector of all the recordTypes.
virtual unsigned int	netSize () const
	Used to obtain the netsize for DIS PDUs.

Static Public Member Functions
static const DtStandardVariableRecordPtrVector &	emptyRecordVector ()
	Return an empty records vector.
static void	setMapByType (bool doMap)
	Set if records should be mapped by type or just kept in a simple vector.
static bool	mapByType ()
	Get whether records are mapped by type or just kept in a simple vector.

Protected Member Functions
virtual void	removeRecordFromMap (DtStandardVariableRecord *record)
	Remove the given record from the mapped type vector. Removes the type vector if it becomes empty.

Protected Attributes
DtStandardVariableRecordPtrVector	myRecordsVector
DtStandardVariableRecordPtrVectorByType	myRecordsByType

Static Protected Attributes
static const DtStandardVariableRecordPtrVector	theEmptyRecordsVector
static bool	theMapByType

Constructor & Destructor Documentation

DtStandardVariableRecordSet::DtStandardVariableRecordSet

(

)

Constructor.

DtStandardVariableRecordSet::DtStandardVariableRecordSet

(

const DtStandardVariableRecordSet &

orig

)

Copy Constructor.

virtual DtStandardVariableRecordSet::~DtStandardVariableRecordSet ( )

virtual

Destructor.

Member Function Documentation

virtual void DtStandardVariableRecordSet::addRecord ( std::auto_ptr< DtStandardVariableRecord >  record )

virtual

Adds a record.

virtual void DtStandardVariableRecordSet::addRecords ( const DtStandardVariableRecordPtrVector &  records )

virtual

Adds the given records.

virtual void DtStandardVariableRecordSet::clearRecords ( )

virtual

Clear all records.

Also this sets number of records to 0

static const DtStandardVariableRecordPtrVector& DtStandardVariableRecordSet::emptyRecordVector ( )

static

Return an empty records vector.

virtual DtStandardVariableRecordPtrVector& DtStandardVariableRecordSet::getRecords ( unsigned int  recordType, DtStandardVariableRecordPtrVector &  recordsOfType  ) const

virtual

Get the vector of records of the given type Any changes to these records will modify the records in the recordSet.

Returns a reference to the records vector being filled

virtual DtStandardVariableRecordPtrVector& DtStandardVariableRecordSet::getRecords ( DtStandardVariableRecordPtrVector &  records ) const

virtual

Get the vector of records Any changes to this record will modify the record in the recordSet.

The recordType can be determined and then this can be casted to a specific record. Returns a reference to the records vector being filled

static bool DtStandardVariableRecordSet::mapByType ( )

static

Get whether records are mapped by type or just kept in a simple vector.

virtual unsigned int DtStandardVariableRecordSet::netSize ( ) const

virtual

Used to obtain the netsize for DIS PDUs.

Reimplemented in DtAttributeRecordSet.

virtual unsigned int DtStandardVariableRecordSet::numberOfRecords ( ) const

virtual

Returns number of records.

virtual DtStandardVariableRecordSet& DtStandardVariableRecordSet::operator= ( const DtStandardVariableRecordSet &  rhs )

virtual

Assignment operator.

virtual void DtStandardVariableRecordSet::printRecords ( ) const

virtual

Prints the data to DtInfo.

virtual void DtStandardVariableRecordSet::printRecordsToStream ( std::ostream &  stream ) const

virtual

Prints the data to the specified stream.

virtual DtStandardVariableRecord* DtStandardVariableRecordSet::recordByIndex ( unsigned int  index ) const

virtual

Returns the record with the given index.

Any changes to this record will modify the record in the recordSet. The recordType can be determined and then this can be casted to a specific record. Note the index must be between 0 and numberOfRecords - 1 If the index is not in this range, this will return 0

virtual DtStandardVariableRecord* DtStandardVariableRecordSet::recordByType ( unsigned int  recordType ) const

virtual

Returns the record with the given type (first one if more than one).

Any changes to this record will modify the record in the recordSet. The recordType can be determined and then this can be casted to a specific record.

virtual const DtStandardVariableRecordPtrVector& DtStandardVariableRecordSet::records ( ) const

virtual

Returns the vector of records.

Any changes to these records will modify the records in the recordSet.

virtual std::vector<unsigned int> DtStandardVariableRecordSet::recordTypes ( ) const

virtual

Returns a vector of all the recordTypes.

Note the indices match that of records() Also if any records are malformed or NULL, then 0 is default value for record type.

virtual void DtStandardVariableRecordSet::removeRecordByIndex ( unsigned int  index )

virtual

Remove the record at the given index.

Also this decrements the number of records. Note the index must be between 0 and numberOfRecords - 1 If the index is not in this range, nothing will happen

virtual int DtStandardVariableRecordSet::removeRecordByType ( unsigned int  recordType, bool  removeAll = true  )

virtual

Remove and discard the first record of the given record type (if there is one) or all them.

Return the number of records removed

virtual void DtStandardVariableRecordSet::removeRecordFromMap ( DtStandardVariableRecord *  record )

protectedvirtual

Remove the given record from the mapped type vector. Removes the type vector if it becomes empty.

static void DtStandardVariableRecordSet::setMapByType ( bool  doMap )

static

Set if records should be mapped by type or just kept in a simple vector.

Member Data Documentation

DtStandardVariableRecordPtrVectorByType DtStandardVariableRecordSet::myRecordsByType

protected

DtStandardVariableRecordPtrVector DtStandardVariableRecordSet::myRecordsVector

protected

const DtStandardVariableRecordPtrVector DtStandardVariableRecordSet::theEmptyRecordsVector

staticprotected

bool DtStandardVariableRecordSet::theMapByType

staticprotected

---

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

• standardVariableRecordSet.h