DtStatusRecord Class Reference

Variable record for sending a status enum. More...

Inheritance diagram for DtStatusRecord:

Collaboration diagram for DtStatusRecord:

Public Member Functions
	DtStatusRecord ()
	Constructor. More...
	DtStatusRecord (const DtStatusRecord &orig)
	Copy Constructor. More...
	DtStatusRecord (void *netBuffer, unsigned int size)
	Net Constructor. More...
virtual	~DtStatusRecord ()
	Destructor. More...
virtual bool	operator== (const DtStatusRecord &other)
	Equals operator. More...
virtual bool	operator== (const DtStandardVariableRecord &other)
	Equals operator. More...
virtual DtActiveStatusEnum	status () const
virtual void	setStatus (DtActiveStatusEnum status)
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...
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
DtActiveStatusEnum	myVrlStatus
DtNetStatusRecord	myNetStatusRecord
Protected Attributes inherited from DtStandardVariableRecord
DtSimulationAddress	myOriginatingSimulationAddress

Static Protected Attributes
static const unsigned int	theMinimumSize

Detailed Description

Variable record for sending a status enum.

Constructor & Destructor Documentation

DtStatusRecord::DtStatusRecord

(

)

Constructor.

DtStatusRecord::DtStatusRecord

(

const DtStatusRecord &

orig

)

Copy Constructor.

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

Net Constructor.

virtual DtStatusRecord::~DtStatusRecord ( )

virtual

Destructor.

Member Function Documentation

virtual DtStandardVariableRecord* DtStatusRecord::clone ( ) const

virtual

Clone.

Implements DtStandardVariableRecord.

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

static

Creator of an unknown record for registering in a factory.

virtual unsigned int DtStatusRecord::netSize ( )

virtual

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

Reimplemented from DtStandardVariableRecord.

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

virtual

Equals operator.

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

virtual

Equals operator.

Implements DtStandardVariableRecord.

virtual void DtStatusRecord::printData ( ) const

virtual

Prints the data to DtInfo.

Reimplemented from DtStandardVariableRecord.

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

virtual

Prints the data to the specified stream.

Implements DtStandardVariableRecord.

virtual unsigned int DtStatusRecord::recordLength ( ) const

virtual

Get/Set Record Length.

Implements DtStandardVariableRecord.

virtual unsigned int DtStatusRecord::recordType ( ) const

virtual

Get/Set Record Type.

Implements DtStandardVariableRecord.

static unsigned int DtStatusRecord::recordTypeToUse ( )

static

Return the attribute record type.

virtual void DtStatusRecord::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 DtStatusRecord::setRecordLength ( unsigned int  recordLength )

virtual

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

Implements DtStandardVariableRecord.

virtual void DtStatusRecord::setRecordType ( unsigned int  recordType )

virtual

Get/Set Record Type.

Implements DtStandardVariableRecord.

virtual void DtStatusRecord::setStatus ( DtActiveStatusEnum  status )

virtual

virtual DtActiveStatusEnum DtStatusRecord::status ( ) const

virtual

virtual unsigned DtStatusRecord::unpaddedNetsize ( ) const

virtual

This is the network size of the record without padding.

Implements DtStandardVariableRecord.

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

virtual

Implements DtStandardVariableRecord.

Member Data Documentation

DtNetStatusRecord DtStatusRecord::myNetStatusRecord

protected

DtActiveStatusEnum DtStatusRecord::myVrlStatus

protected

const unsigned int DtStatusRecord::theMinimumSize

staticprotected

---

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

• statusRecord.h