VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtSignalMessageHeader Class Reference

DtSignalMessageHeader. More...

Public Member Functions

 DtSignalMessageHeader ()
 constructor More...
 
 DtSignalMessageHeader (const DtSignalMessageHeader &orig)
 copy constructor More...
 
virtual ~DtSignalMessageHeader ()
 Destructor. More...
 
const DtSignalMessageHeaderoperator= (DtSignalMessageHeader &orig)
 assignment operator More...
 
virtual DtSignalMessageHeaderclone () const
 Required override. Copies itself. More...
 
virtual int netRepSize () const
 returns the size of the buffer needed to represent this message More...
 
virtual bool setFromNet (const char *networkBuffer, unsigned contentSize)
 Sets members based on DtNetSplitMessageHandle buffer. More...
 
virtual bool setToNet (char *networkBuffer) const
 writes DtNetSplitMessageHandle values and myVrfObjectMessage to networkBuffer, copying myVrfObjectMessage->netRep() only up to DtMessageExecutive::maximumContentSize(). More...
 
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 More...
 
void setVrfMessageVersion (DtU32 msgver)
 

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. More...
 

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
inlinevirtual

References myFullMessageSize.

void DtSignalMessageHeader::setFullMessageSize ( unsigned  nSize)
inlinevirtual

References myFullMessageSize.

unsigned DtSignalMessageHeader::messageIdNumber ( ) const
inlinevirtual

References myMessageNumber.

void DtSignalMessageHeader::setMessageIdNumber ( unsigned  sNum)
inlinevirtual

References myMessageNumber.

const DtSimulationAddress & DtSignalMessageHeader::messageIdSenderAddress ( ) const
inlinevirtual

References myMessageSimulatorId.

void DtSignalMessageHeader::setMessageIdSenderAddress ( const DtSimulationAddress &  simAddr)
inlinevirtual

References myMessageSimulatorId.

virtual int DtSignalMessageHeader::netRepSize ( ) const
virtual

returns the size of the buffer needed to represent this message

unsigned DtSignalMessageHeader::numberOfChunks ( ) const
inlinevirtual

References myNumberOfChunks.

void DtSignalMessageHeader::setNumberOfChunks ( unsigned  nNum)
inlinevirtual

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
inlinevirtual

References mySequenceId.

void DtSignalMessageHeader::setSequenceId ( unsigned  sSeqId)
inlinevirtual

References mySequenceId.

unsigned DtSignalMessageHeader::sizeOfThisChunk ( ) const
inlinevirtual

References mySizeOfThisChunk.

void DtSignalMessageHeader::setSizeOfThisChunk ( unsigned  nSize)
inlinevirtual

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

Member Data Documentation

unsigned DtSignalMessageHeader::myFullMessageSize
protected
unsigned DtSignalMessageHeader::myMessageNumber
protected
DtSimulationAddress DtSignalMessageHeader::myMessageSimulatorId
protected
unsigned DtSignalMessageHeader::myNumberOfChunks
protected
unsigned DtSignalMessageHeader::mySequenceId
protected

Referenced by sequenceId(), and setSequenceId().

unsigned DtSignalMessageHeader::mySizeOfThisChunk
protected
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:

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)