DtSignalMessageHeader Class Reference

DtSignalMessageHeader. More...

List of all members.

Public Member Functions
	DtSignalMessageHeader ()
	constructor
	DtSignalMessageHeader (const DtSignalMessageHeader &orig)
	copy constructor
virtual	~DtSignalMessageHeader ()
	Destructor.
const DtSignalMessageHeader &	operator= (DtSignalMessageHeader &orig)
	assignment operator
virtual DtSignalMessageHeader *	clone () const
	Required override. Copies itself.
virtual int	netRepSize () const
	returns the size of the buffer needed to represent this message
virtual bool	setFromNet (const char *networkBuffer, unsigned contentSize)
	Sets members based on DtNetSplitMessageHandle buffer.
virtual bool	setToNet (char *networkBuffer) const
	writes DtNetSplitMessageHandle values and myVrfObjectMessage to networkBuffer, copying myVrfObjectMessage->netRep() only up to DtMessageExecutive::maximumContentSize().
virtual void	printDataToString (DtString &str)
virtual unsigned	fullMessageSize () const
virtual void	setFullMessageSize (unsigned nSize)
virtual unsigned	messageIdNumber () const
virtual void	setMessageIdNumber (unsigned sNum)
virtual const DtSimulationAddress &	messageIdSenderAddress () const
virtual void	setMessageIdSenderAddress (const DtSimulationAddress &simAddr)
virtual unsigned	numberOfChunks () const
virtual void	setNumberOfChunks (unsigned nNum)
virtual unsigned	sequenceId () const
virtual void	setSequenceId (unsigned sSeqId)
virtual unsigned	sizeOfThisChunk () const
virtual void	setSizeOfThisChunk (unsigned nSize)
DtU32	vrfMessageVersion () const
	accessors & mutators
void	setVrfMessageVersion (DtU32 msgver)
	accessors & mutators
Protected Attributes
unsigned	myFullMessageSize
unsigned	myMessageNumber
DtSimulationAddress	myMessageSimulatorId
unsigned	myNumberOfChunks
unsigned	mySequenceId
unsigned	mySizeOfThisChunk
DtU32	myVrfMessageVersionSupported
	vrf message version defined in version.h, or as overridden.

---

Detailed Description

DtSignalMessageHeader.

Used in the creation of signal interactions, to add VRF message version information.

---

Constructor & Destructor Documentation

DtSignalMessageHeader::DtSignalMessageHeader

(

)

constructor

DtSignalMessageHeader::DtSignalMessageHeader

(

const DtSignalMessageHeader &

orig

)

copy constructor

virtual DtSignalMessageHeader::~DtSignalMessageHeader

(

)

[virtual]

Destructor.

---

Member Function Documentation

const DtSignalMessageHeader& DtSignalMessageHeader::operator=

(

DtSignalMessageHeader &

orig

)

assignment operator

virtual DtSignalMessageHeader* DtSignalMessageHeader::clone

(

)

const [virtual]

Required override. Copies itself.

unsigned DtSignalMessageHeader::fullMessageSize

(

)

const [inline, virtual]

References myFullMessageSize.

void DtSignalMessageHeader::setFullMessageSize

(

unsigned

nSize

)

[inline, virtual]

References myFullMessageSize.

unsigned DtSignalMessageHeader::messageIdNumber

(

)

const [inline, virtual]

References myMessageNumber.

void DtSignalMessageHeader::setMessageIdNumber

(

unsigned

sNum

)

[inline, virtual]

References myMessageNumber.

const DtSimulationAddress & DtSignalMessageHeader::messageIdSenderAddress

(

)

const [inline, virtual]

References myMessageSimulatorId.

void DtSignalMessageHeader::setMessageIdSenderAddress

(

const DtSimulationAddress &

simAddr

)

[inline, virtual]

References myMessageSimulatorId.

virtual int DtSignalMessageHeader::netRepSize

(

)

const [virtual]

returns the size of the buffer needed to represent this message

unsigned DtSignalMessageHeader::numberOfChunks

(

)

const [inline, virtual]

References myNumberOfChunks.

void DtSignalMessageHeader::setNumberOfChunks

(

unsigned

nNum

)

[inline, virtual]

References myNumberOfChunks.

virtual bool DtSignalMessageHeader::setFromNet	(	const char *	networkBuffer,
		unsigned	contentSize
	)		[virtual]

Sets members based on DtNetSplitMessageHandle buffer.

virtual bool DtSignalMessageHeader::setToNet

(

char *

networkBuffer

)

const [virtual]

writes DtNetSplitMessageHandle values and myVrfObjectMessage to networkBuffer, copying myVrfObjectMessage->netRep() only up to DtMessageExecutive::maximumContentSize().

Buffer is assumed to have been allocated with at least the size returned from a call to DtBufferSerialize::getSize(DtSignalMessageHeader&);

unsigned DtSignalMessageHeader::sequenceId

(

)

const [inline, virtual]

References mySequenceId.

void DtSignalMessageHeader::setSequenceId

(

unsigned

sSeqId

)

[inline, virtual]

References mySequenceId.

unsigned DtSignalMessageHeader::sizeOfThisChunk

(

)

const [inline, virtual]

References mySizeOfThisChunk.

void DtSignalMessageHeader::setSizeOfThisChunk

(

unsigned

nSize

)

[inline, virtual]

References mySizeOfThisChunk.

virtual void DtSignalMessageHeader::printDataToString

(

DtString &

str

)

[virtual]

DtU32 DtSignalMessageHeader::vrfMessageVersion

(

)

const [inline]

accessors & mutators

represents the vrf message ID that should prefix the interaction.

References myVrfMessageVersionSupported.

void DtSignalMessageHeader::setVrfMessageVersion

(

DtU32

msgver

)

[inline]

accessors & mutators

represents the vrf message ID that should prefix the interaction.

References myVrfMessageVersionSupported.

---

Member Data Documentation

unsigned DtSignalMessageHeader::myFullMessageSize [protected]

Referenced by fullMessageSize(), and setFullMessageSize().

unsigned DtSignalMessageHeader::myMessageNumber [protected]

Referenced by messageIdNumber(), and setMessageIdNumber().

DtSimulationAddress DtSignalMessageHeader::myMessageSimulatorId [protected]

Referenced by messageIdSenderAddress(), and setMessageIdSenderAddress().

unsigned DtSignalMessageHeader::myNumberOfChunks [protected]

Referenced by numberOfChunks(), and setNumberOfChunks().

unsigned DtSignalMessageHeader::mySequenceId [protected]

Referenced by sequenceId(), and setSequenceId().

unsigned DtSignalMessageHeader::mySizeOfThisChunk [protected]

Referenced by setSizeOfThisChunk(), and sizeOfThisChunk().

DtU32 DtSignalMessageHeader::myVrfMessageVersionSupported [protected]

vrf message version defined in version.h, or as overridden.

Referenced by setVrfMessageVersion(), and vrfMessageVersion().

---

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

• include/vrfmsgs/signalMessageHeader.h