DtSymbolIdRecord Class Reference

Variable record for sending the SymbolId string. More...

Inheritance diagram for DtSymbolIdRecord:

Collaboration diagram for DtSymbolIdRecord:

Public Member Functions
	DtSymbolIdRecord ()
	Constructor. More...
	DtSymbolIdRecord (const DtSymbolIdRecord &orig)
	Copy Constructor. More...
	DtSymbolIdRecord (void *netBuffer, unsigned int size)
	Net Constructor. More...
virtual	~DtSymbolIdRecord ()
	Destructor. More...
virtual bool	operator== (const DtSymbolIdRecord &other)
	Equals operator. More...
virtual bool	operator== (const DtStandardVariableRecord &other)
	Equals operator. More...
virtual void	printData () const
	Prints the data to DtInfo. More...
virtual void	printDataToStream (std::ostream &stream) const
	Prints the data to the specified stream. More...
virtual void	writeRecord (void *addr) const
virtual void	setFromNet (const void *netRecord, unsigned int length, DtStandardVariableRetCode *retCode=NULL)
	Sets the record from Network Representation from the given location. More...
virtual unsigned	unpaddedNetsize () const
	This is the network size of the record without padding. More...
virtual unsigned int	netSize ()
	Returns the size of the network representation (including padding bytes) More...
virtual DtStandardVariableRecord *	clone () const
	Clone. More...
virtual unsigned int	recordType () const
	Get/Set Record Type. More...
virtual void	setRecordType (unsigned int recordType)
	Get/Set Record Type. More...
virtual unsigned int	recordLength () const
	Get/Set Record Length. More...
virtual void	setRecordLength (unsigned int recordLength)
	Must include size of record header and padding to 8 bytes. More...
virtual unsigned int	stringLength () const
	Get/Set String Length. More...
virtual void	setStringLength (unsigned int stringLength)
	Setting the size of the string. More...
virtual std::wstring	symbolId () const
	Get/Set SymbolID. More...
virtual void	setSymbolId (const std::wstring &symbolId)
	Setting the Symbol ID. More...
Public Member Functions inherited from DtStandardVariableRecord
	DtStandardVariableRecord ()
	Constructor. More...
virtual	~DtStandardVariableRecord ()
	Destructor. More...
virtual void	setOriginatingSimulationAddress (const DtSimulationAddress &)
virtual const DtSimulationAddress &	originatingSimulationAddress () const

Static Public Member Functions
static DtStandardVariableRecord *	create (void *addr, unsigned int length)
	Creator of an unknown record for registering in a factory. More...
static unsigned int	recordTypeToUse ()
	Return the attribute record type. More...

Protected Attributes
std::wstring	mySymbolId
DtNetSymbolIdRecord	myNetSymbolIdRecord
int	mySymbolIdPadding
Protected Attributes inherited from DtStandardVariableRecord
DtSimulationAddress	myOriginatingSimulationAddress

Static Protected Attributes
static const unsigned int	theMinimumSize

Detailed Description

Variable record for sending the SymbolId string.

Constructor & Destructor Documentation

DtSymbolIdRecord::DtSymbolIdRecord

(

)

Constructor.

DtSymbolIdRecord::DtSymbolIdRecord

(

const DtSymbolIdRecord &

orig

)

Copy Constructor.

DtSymbolIdRecord::DtSymbolIdRecord	(	void *	netBuffer,
		unsigned int	size
	)

Net Constructor.

virtual DtSymbolIdRecord::~DtSymbolIdRecord ( )

virtual

Destructor.

Member Function Documentation

virtual DtStandardVariableRecord* DtSymbolIdRecord::clone ( ) const

virtual

Clone.

Implements DtStandardVariableRecord.

static DtStandardVariableRecord* DtSymbolIdRecord::create ( void *  addr, unsigned int  length  )

static

Creator of an unknown record for registering in a factory.

virtual unsigned int DtSymbolIdRecord::netSize ( )

virtual

Returns the size of the network representation (including padding bytes)

Reimplemented from DtStandardVariableRecord.

virtual bool DtSymbolIdRecord::operator== ( const DtSymbolIdRecord &  other )

virtual

Equals operator.

virtual bool DtSymbolIdRecord::operator== ( const DtStandardVariableRecord &  other )

virtual

Equals operator.

Implements DtStandardVariableRecord.

virtual void DtSymbolIdRecord::printData ( ) const

virtual

Prints the data to DtInfo.

Reimplemented from DtStandardVariableRecord.

virtual void DtSymbolIdRecord::printDataToStream ( std::ostream &  stream ) const

virtual

Prints the data to the specified stream.

Implements DtStandardVariableRecord.

virtual unsigned int DtSymbolIdRecord::recordLength ( ) const

virtual

Get/Set Record Length.

Implements DtStandardVariableRecord.

virtual unsigned int DtSymbolIdRecord::recordType ( ) const

virtual

Get/Set Record Type.

Implements DtStandardVariableRecord.

static unsigned int DtSymbolIdRecord::recordTypeToUse ( )

static

Return the attribute record type.

virtual void DtSymbolIdRecord::setFromNet ( const void *  netRecord, unsigned int  length, DtStandardVariableRetCode *  retCode = NULL  )

virtual

Sets the record from Network Representation from the given location.

Memory must exist for life of the variable record

Implements DtStandardVariableRecord.

virtual void DtSymbolIdRecord::setRecordLength ( unsigned int  recordLength )

virtual

Must include size of record header and padding to 8 bytes.

Implements DtStandardVariableRecord.

virtual void DtSymbolIdRecord::setRecordType ( unsigned int  recordType )

virtual

Get/Set Record Type.

Implements DtStandardVariableRecord.

virtual void DtSymbolIdRecord::setStringLength ( unsigned int  stringLength )

virtual

Setting the size of the string.

virtual void DtSymbolIdRecord::setSymbolId ( const std::wstring &  symbolId )

virtual

Setting the Symbol ID.

virtual unsigned int DtSymbolIdRecord::stringLength ( ) const

virtual

Get/Set String Length.

virtual std::wstring DtSymbolIdRecord::symbolId ( ) const

virtual

Get/Set SymbolID.

virtual unsigned DtSymbolIdRecord::unpaddedNetsize ( ) const

virtual

This is the network size of the record without padding.

Implements DtStandardVariableRecord.

virtual void DtSymbolIdRecord::writeRecord ( void *  addr ) const

virtual

Implements DtStandardVariableRecord.

Member Data Documentation

DtNetSymbolIdRecord DtSymbolIdRecord::myNetSymbolIdRecord

protected

std::wstring DtSymbolIdRecord::mySymbolId

protected

int DtSymbolIdRecord::mySymbolIdPadding

mutableprotected

const unsigned int DtSymbolIdRecord::theMinimumSize

staticprotected

---

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

• symbolIdRecord.h