DtIoCommunicationsNodeRecord Class Reference

Inheritance diagram for DtIoCommunicationsNodeRecord:

Collaboration diagram for DtIoCommunicationsNodeRecord:

Public Member Functions
	DtIoCommunicationsNodeRecord ()
	Constructor. More...
	DtIoCommunicationsNodeRecord (DtCommsNodeType communicationsNodeType, const DtCommunicationsNodeIdRecord &communicationsNodeId)
	Constructor. More...
	DtIoCommunicationsNodeRecord (const DtIoCommunicationsNodeRecord &orig)
	Copy Constructor. More...
	DtIoCommunicationsNodeRecord (void *ptr, unsigned int length)
	Net Constructor. More...
virtual DtIoCommunicationsNodeRecord &	operator= (const DtIoCommunicationsNodeRecord &other)
	Assignment operator. More...
virtual DtStandardVariableRecord &	operator= (const DtStandardVariableRecord &record)
	Assignment operator. More...
virtual bool	operator== (const DtIoCommunicationsNodeRecord &other)
	Equals operator. More...
virtual bool	operator== (const DtStandardVariableRecord &other)
	Equals operator. More...
virtual unsigned int	recordType () const
	Setters and Getters for Record Type. More...
virtual void	setRecordType (unsigned int recordType)
	Get/Set Record Type. More...
virtual unsigned int	recordLength () const
	Setters and Getters for Record Length. More...
virtual void	setRecordLength (unsigned int recordLength)
	Must include size of record header and padding to 8 bytes. More...
virtual DtCommsNodeType	communicationsNodeType () const
	Setters and Getters for Communications Node type. More...
virtual void	setCommunicationsNodeType (DtCommsNodeType communicationsNodeType)
virtual const DtCommunicationsNodeIdRecord &	communicationsNodeId () const
	Setters and Getters for Communications Node ID. More...
virtual void	setCommunicationsNodeId (const DtCommunicationsNodeIdRecord &communicationsNodeId)
virtual void	printDataToStream (std::ostream &stream) const
	Prints the data to the specified stream. More...
virtual void	writeRecord (void *addr) const
	Writes the network representation to the given address. More...
virtual void	setFromNet (const void *netRecord, unsigned int length, DtStandardVariableRetCode *retCode=NULL)
	Sets the record from an address and length. Retcode will be Valid if all goes well. More...
virtual unsigned int	unpaddedNetsize () const
	Returns the size of the network representation (without padding bytes) More...
virtual unsigned int	netSize () const
	This overrides netSize because this Record is a special case as it is of a fixed size and Will never require padding. More...
virtual DtStandardVariableRecord *	clone () const
	Clone. More...
Public Member Functions inherited from DtStandardVariableRecord
	DtStandardVariableRecord ()
	Constructor. More...
virtual	~DtStandardVariableRecord ()
	Destructor. More...
virtual void	printData () const
	Prints the data to DtInfo. More...
virtual unsigned int	netSize ()
	Returns the size of the network representation (including padding bytes) More...
virtual void	setOriginatingSimulationAddress (const DtSimulationAddress &)
virtual const DtSimulationAddress &	originatingSimulationAddress () const

Static Public Member Functions
static DtStandardVariableRecord *	create (void *addr, unsigned int length)
	Create function used by Standard Variable Record Factory. More...

Protected Attributes
DtCommunicationsNodeIdRecord	myCommunicationsNodeIdRecord
DtNetIoCommunicationsNodeRecord	myIoCommunicationsNodeRecord
Protected Attributes inherited from DtStandardVariableRecord
DtSimulationAddress	myOriginatingSimulationAddress

Constructor & Destructor Documentation

DtIoCommunicationsNodeRecord::DtIoCommunicationsNodeRecord

(

)

Constructor.

DtIoCommunicationsNodeRecord::DtIoCommunicationsNodeRecord	(	DtCommsNodeType	communicationsNodeType,
		const DtCommunicationsNodeIdRecord &	communicationsNodeId
	)

Constructor.

DtIoCommunicationsNodeRecord::DtIoCommunicationsNodeRecord

(

const DtIoCommunicationsNodeRecord &

orig

)

Copy Constructor.

DtIoCommunicationsNodeRecord::DtIoCommunicationsNodeRecord	(	void *	ptr,
		unsigned int	length
	)

Net Constructor.

Member Function Documentation

virtual DtStandardVariableRecord* DtIoCommunicationsNodeRecord::clone ( ) const

virtual

Clone.

Implements DtStandardVariableRecord.

virtual const DtCommunicationsNodeIdRecord& DtIoCommunicationsNodeRecord::communicationsNodeId ( ) const

virtual

Setters and Getters for Communications Node ID.

virtual DtCommsNodeType DtIoCommunicationsNodeRecord::communicationsNodeType ( ) const

virtual

Setters and Getters for Communications Node type.

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

static

Create function used by Standard Variable Record Factory.

virtual unsigned int DtIoCommunicationsNodeRecord::netSize ( ) const

virtual

This overrides netSize because this Record is a special case as it is of a fixed size and Will never require padding.

virtual DtIoCommunicationsNodeRecord& DtIoCommunicationsNodeRecord::operator= ( const DtIoCommunicationsNodeRecord &  other )

virtual

Assignment operator.

virtual DtStandardVariableRecord& DtIoCommunicationsNodeRecord::operator= ( const DtStandardVariableRecord &  record )

virtual

Assignment operator.

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

virtual

Equals operator.

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

virtual

Equals operator.

Implements DtStandardVariableRecord.

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

virtual

Prints the data to the specified stream.

Implements DtStandardVariableRecord.

virtual unsigned int DtIoCommunicationsNodeRecord::recordLength ( ) const

virtual

Setters and Getters for Record Length.

Implements DtStandardVariableRecord.

virtual unsigned int DtIoCommunicationsNodeRecord::recordType ( ) const

virtual

Setters and Getters for Record Type.

Implements DtStandardVariableRecord.

virtual void DtIoCommunicationsNodeRecord::setCommunicationsNodeId ( const DtCommunicationsNodeIdRecord &  communicationsNodeId )

virtual

virtual void DtIoCommunicationsNodeRecord::setCommunicationsNodeType ( DtCommsNodeType  communicationsNodeType )

virtual

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

virtual

Sets the record from an address and length. Retcode will be Valid if all goes well.

Implements DtStandardVariableRecord.

virtual void DtIoCommunicationsNodeRecord::setRecordLength ( unsigned int  recordLength )

virtual

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

Implements DtStandardVariableRecord.

virtual void DtIoCommunicationsNodeRecord::setRecordType ( unsigned int  recordType )

virtual

Get/Set Record Type.

Implements DtStandardVariableRecord.

virtual unsigned int DtIoCommunicationsNodeRecord::unpaddedNetsize ( ) const

virtual

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

Implements DtStandardVariableRecord.

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

virtual

Writes the network representation to the given address.

The assumption is that this memory is allocated and is of the proper size.

Implements DtStandardVariableRecord.

Member Data Documentation

DtCommunicationsNodeIdRecord DtIoCommunicationsNodeRecord::myCommunicationsNodeIdRecord

protected

DtNetIoCommunicationsNodeRecord DtIoCommunicationsNodeRecord::myIoCommunicationsNodeRecord

protected

---

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

• ioCommunicationsNodeRecord.h