DtRouteRecord Class Reference

Variable record for sending the Route enum. More...

Inheritance diagram for DtRouteRecord:

Collaboration diagram for DtRouteRecord:

Public Member Functions
	DtRouteRecord ()
	Constructor. More...
	DtRouteRecord (const DtRouteRecord &orig)
	Copy Constructor. More...
	DtRouteRecord (void *netBuffer, unsigned int size)
	Net Constructor. More...
virtual	~DtRouteRecord ()
	Destructor. More...
virtual bool	operator== (const DtRouteRecord &other)
	Equals operator. More...
virtual bool	operator== (const DtStandardVariableRecord &other)
	Equals operator. More...
virtual DtVrlUuid	routeUuid () const
virtual void	setRouteUuid (DtVrlUuid uuid)
virtual std::vector< DtVector >	routeWaypoints () const
virtual void	setRouteWaypoints (const std::vector< DtVector > location)
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 DtPathTypeEnum	getPathType () const
	Returns the point type enum. 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
DtPathVariantStruct	myRoute
DtNetRouteRecord	myNetRouteRecord
Protected Attributes inherited from DtStandardVariableRecord
DtSimulationAddress	myOriginatingSimulationAddress

Static Protected Attributes
static const unsigned int	theMinimumSize

Detailed Description

Variable record for sending the Route enum.

Constructor & Destructor Documentation

DtRouteRecord::DtRouteRecord

(

)

Constructor.

DtRouteRecord::DtRouteRecord

(

const DtRouteRecord &

orig

)

Copy Constructor.

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

Net Constructor.

virtual DtRouteRecord::~DtRouteRecord ( )

virtual

Destructor.

Member Function Documentation

virtual DtStandardVariableRecord* DtRouteRecord::clone ( ) const

virtual

Clone.

Implements DtStandardVariableRecord.

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

static

Creator of an unknown record for registering in a factory.

virtual DtPathTypeEnum DtRouteRecord::getPathType ( ) const

virtual

Returns the point type enum.

virtual unsigned int DtRouteRecord::netSize ( )

virtual

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

Reimplemented from DtStandardVariableRecord.

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

virtual

Equals operator.

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

virtual

Equals operator.

Implements DtStandardVariableRecord.

virtual void DtRouteRecord::printData ( ) const

virtual

Prints the data to DtInfo.

Reimplemented from DtStandardVariableRecord.

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

virtual

Prints the data to the specified stream.

Implements DtStandardVariableRecord.

virtual unsigned int DtRouteRecord::recordLength ( ) const

virtual

Get/Set Record Length.

Implements DtStandardVariableRecord.

virtual unsigned int DtRouteRecord::recordType ( ) const

virtual

Get/Set Record Type.

Implements DtStandardVariableRecord.

static unsigned int DtRouteRecord::recordTypeToUse ( )

static

Return the attribute record type.

virtual DtVrlUuid DtRouteRecord::routeUuid ( ) const

virtual

virtual std::vector<DtVector> DtRouteRecord::routeWaypoints ( ) const

virtual

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

virtual

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

Implements DtStandardVariableRecord.

virtual void DtRouteRecord::setRecordType ( unsigned int  recordType )

virtual

Get/Set Record Type.

Implements DtStandardVariableRecord.

virtual void DtRouteRecord::setRouteUuid ( DtVrlUuid  uuid )

virtual

virtual void DtRouteRecord::setRouteWaypoints ( const std::vector< DtVector >  location )

virtual

virtual unsigned DtRouteRecord::unpaddedNetsize ( ) const

virtual

This is the network size of the record without padding.

Implements DtStandardVariableRecord.

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

virtual

Implements DtStandardVariableRecord.

Member Data Documentation

DtNetRouteRecord DtRouteRecord::myNetRouteRecord

protected

DtPathVariantStruct DtRouteRecord::myRoute

protected

const unsigned int DtRouteRecord::theMinimumSize

staticprotected

---

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

• routeRecord.h