DtInteractionMsg Class Reference

DtInteractionMsg is a message type that represents an HLA Interaction. More...

Inheritance diagram for DtInteractionMsg:

Collaboration diagram for DtInteractionMsg:

Public Member Functions
	DtInteractionMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor. More...
virtual	~DtInteractionMsg ()
	Destructor. More...
virtual void	setChannel (unsigned long handleValue)
	Set/Get DDM channel. More...
virtual unsigned long	channel () const
virtual void	setHandle (DtInteractionClassHandle hand)=0
	Set/Get handle. More...
virtual DtInteractionClassHandle	handle () const =0
virtual void	setObjectHandle (DtInteractionClassHandle hand)=0
	Set/Get object instance handle. More...
virtual DtObjectInstanceHandle	objectHandle () const =0
virtual void	setTag (DtRtiApiTagConstRef tag, bool adjustBufferSize=true)
	Set/Get tag (adjust buffer size if not pre-allocated for this data) More...
virtual DtRtiApiTagConstRef	tag () const
virtual void	setParams (const DtPhvps &theParameters, bool adjustBufferSize=true)
	Set/Get parameters (adjust buffer size if not pre-allocated for this data) More...
virtual void	getParams (DtPhvps &params, bool useMsgMemory, DtInteractionClassInfo const *classInfo=NULL) const
	Parameter value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed parameters if class info is provided otherwise gets all parameters in message. More...
virtual unsigned long	numParams () const
	Get number of parameters. More...
Public Member Functions inherited from DtRtiMsg
virtual	~DtRtiMsg ()
	Destructor. More...
virtual DtRtiMsg *	clone (bool copy=true) const =0
	Return a copy/empty object of the same type as this. More...
virtual DtRtiMsg *	cloneWithTransport (bool copy=true) const
	Return a copy/empty object of the same type as this using clone and set the transport type from the host message. More...
virtual DtNetMsgHeader *	netHeader () const
	Get header of network representation. More...
virtual int	version () const
	Return the message version. More...
virtual bool	isValidVersion () const
	Returns bool: message version is valid? More...
virtual void	setFedEx (const MAKRti::DtString &name)
	All RTI messages contain information to identify which federation execution the message applies to. More...
virtual void	setFedEx (int handle)
	Set federation execution identifier as a handle. More...
virtual bool	isForExec (const MAKRti::DtString &execName, int execHandle) const
	Returns true if the current message belongs to the indicated federation execution, false otherwise. More...
virtual DtRtiMsgKind	msgKind () const
	Get the message kind. More...
virtual const char *	kindString () const
	Returns the message kind string name. More...
virtual bool	isConstrained () const
	Return boolean: message type can be time constrained? More...
virtual bool	isAllowedDuringSave () const
	Return boolean: message type can be processed during save? More...
virtual void	setTime (const DtRtiApiTime &time)
	Set/Get time Used in timestamped messages. More...
virtual DtRtiApiTime const *	time (DtLogicalTimeFactory *fedTimeFactory) const
virtual bool	hasTime () const
	Returns true if time field is valid. More...
virtual void	setSerialNumber (unsigned long serialNumberValue)
	Set/Get event retraction serial number Used in timestamped messages. More...
virtual unsigned long	serialNumber () const
virtual void	setTransportType (DtTransportHandle type)
	Set/Get transport type. More...
virtual DtTransportHandle	transportType () const
virtual DtOrderHandle	orderType () const
	This base implementation always returns recieve order. More...
virtual bool	isMetadataPresent () const
	Test if metadata has been added to a DtRtiMsg object. More...
virtual bool	addMetadata (caddr_t *mtdAddr, unsigned int size, unsigned int *alignPad, unsigned int *headerPad=NULL)
	Allocate space for next block of metadata. More...
virtual void	removeMetadata (unsigned int size)
	Update the size of the message when metadata has been removed. More...
bool	isInteractionMsgType () const
	Utility functions, check the message type against known interaciton/update message types. More...
bool	isUpdateMsgType () const
virtual void	print (DtLogicalTimeFactory *logicalTimeFactory) const
	Printing functions. More...
virtual void	printHeader (DtLogicalTimeFactory *logicalTimeFactory) const
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
virtual void	printTime (const char *label, DtRtiApiTime const *timeValue) const
	Print the given time. More...
virtual void	printInterval (const char *label, DtRtiApiTimeInterval const *intervalValue) const
	Print the interval. More...
virtual int	status () const
	Returns MSG_STATUS_OK if OK, a reason enumeration otherwise. More...
virtual int	timeFieldSize (int encodedLength) const
	Returns size of a timestamp field (including byte alignment adjustment) given the time's encoded length. More...
virtual int	tagFieldSize (int encodedLength) const
	Returns size of a tag field (including byte alignment adjustment) given the tag's encoded length. More...
virtual const MAKRti::DtString	fedExName () const
	These two functions should be avoided in favor of isForExec(). More...
virtual int	fedExHandle () const
	Get the federation execution identifier as a handle Returns 0 if the identifier is being represented as a name. More...
virtual void	setFederateHandle (DtFederateHandle handle)
	Set/Get federate handle. More...
virtual DtFederateHandle	federateHandle () const
	Set/Get federate handle. More...
virtual void	setSequenceNumber (unsigned long value)
	Set/Get message sequence number. More...
virtual unsigned long	sequenceNumber () const
	Set/Get message sequence number. More...
virtual void	setServiceCallNumber (unsigned long value)
	Set/Get service call number. More...
virtual unsigned long	serviceCallNumber () const
	Set/Get service call number. More...
virtual void	setTriggerMessageNumber (unsigned long value)
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent). More...
virtual unsigned long	triggerMessageNumber () const
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent). More...

Static Public Member Functions
static void	setChannelIncluded (bool includeChannel)
	Set/Get flag to include DDM channel identifier. More...
static bool	channelIncluded ()
Static Public Member Functions inherited from DtRtiMsg
static const DtNetMsgHeader *	netHeader (const void *buffer)
	Extracts the header network representation from the buffer. More...
static const char *	kindToString (DtRtiMsgKind kind)
	Returns the name of the message, by kind enumeration. More...
static const char *	kindString (const void *buffer)
	Extracts the message kind from the given buffer and returns its string name. More...
static unsigned long	totalSize (const void *buffer)
	Extracts the message total size form the given buffer. More...
static const DtRtiMsgKind	msgKind (const void *buffer)
	Extracts the message kind from the given buffer. More...
static unsigned int	version (const void *buffer)
	Extracts the message version form the given buffer. More...
static unsigned int	fedExHandle (const void *buffer)
	Extracts the message fedEx handle form the given buffer (0 if lightweight fedEx name) More...
static DtFederateHandle	federateHandle (const void *buffer)
	Extracts the message federate handle form the given buffer. More...
static unsigned long	sequenceNumber (const void *buffer)
	Extracts the message sequence number form the given buffer. More...
static unsigned char	flags (const void *buffer)
	Extracts the message flags form the given buffer. More...
static unsigned long	metadataSize (const void *buffer)
	Extracts the message metadata size form the given buffer. More...
static void	setDefaultRegionSet (unsigned long defaultRegionSet)
	Set the default region set handle. More...
static void	setUse32BitsForValueSize (bool use32BitsForValueSizeEnabled)
	Set/Get flag to enable use of 32 bit size field for attribute/parameter values. More...
static bool	use32BitsForValueSize ()
static void	setSmartForwardingEnabled (bool enabled)
	Set/Get is SmartForwarding enabled? More...
static bool	smartForwardingEnabled ()

Protected Member Functions
virtual void	setTagSize (int size)=0
	Set/Get tag size. More...
virtual int	tagSize () const =0
virtual DtNetU32 *	channelPtr () const =0
	Returns pointer to the channel in the netMsg. More...
virtual char *	tagPtr ()=0
	Returns pointer to the tag in the netMsg. More...
virtual DtNetParams *	netParams ()=0
	Returns pointer to the network rep of the pvList. More...
virtual DtNetBigParams *	netBigParams ()=0
	Returns pointer to the network rep of the pvList. More...
virtual DtNetParamValue *	nextNetParam (char *netParamTail) const
	Given the tail end of the current parameter, return the pointer to next parameter header in the network rep. More...
virtual DtNetBigParamValue *	nextNetBigParam (char *netParamTail) const
	Given the tail end of the current parameter, return the pointer to next parameter header in the network rep. More...
virtual void	fillFromNetParams (const DtNetParams *netRepParams, DtPhvps &params, bool useMsgMemory, DtInteractionClassInfo const *classInfo=NULL) const
	Fill the given parameter set with the message's parameters Parameter value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed attributes if class info is provided otherwise gets all attributes in message. More...
virtual void	fillFromNetBigParams (const DtNetBigParams *netRepParams, DtPhvps &params, bool useMsgMemory, DtInteractionClassInfo const *classInfo=NULL) const
	Fill the given parameter set with the message's parameters Supports parameter values > 64K Parameter value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed attributes if class info is provided otherwise gets all attributes in message. More...
virtual void	fillNetParams (const DtPhvps &theParameters, DtNetParams *netRepParams)
	Fill message with given parameter set. More...
virtual void	fillNetBigParams (const DtPhvps &theParameters, DtNetBigParams *netRepParams)
	Supports parameter values > 64K. More...
virtual void	adjustBufferForParams (const DtPhvps &params)
	Adjust size/bytes for the network rep of the avList. More...
virtual unsigned long	sizeNeededForNetParam (unsigned long paramOffset, unsigned long paramSize) const
	Returns the size the network representation will consume. More...
virtual unsigned long	sizeNeededForNetParams (unsigned long paramOffset, const DtPhvps &params) const
	Returns the size the network representation will consume. More...
virtual int	channelFieldSize () const
	Returns size of channel field. More...
virtual int	tagFieldSize () const
	Returns size of tag field. More...
virtual int	paramAlignPaddingSize (unsigned long offset) const
	Returns size of param list alignment padding. More...
virtual DtInteractionMsg *	self () const
	Returns pointer to the serial number in the netMsg. More...
Protected Member Functions inherited from DtRtiMsg
	DtRtiMsg ()
	Constructor. More...
virtual DtRtiMsgKind	internalDtRtiMsgKind ()=0
virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes. More...
void	initDtRtiMsg (int size, DtRtiMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual. More...
void	initDtRtiMsg (const void *initial, int size, DtBufferPtr buffer)
void	initDtRtiMsg (const DtNetMsgHeader *header, DtBufferPtr buffer)
virtual void	adjustBytes (int offset, int numBytes)
	Adjust numBytes bytes at the indicated offset in the net rep. More...
virtual void	adjustBytes (void *address, int numBytes)
	Adjust the numBytes starting at the indicated addres. More...

Protected Attributes
DtRtiApiTagPtr	myTag
int	myParamHdrAlignment
int	myParamListHdrSize
int	myParamHdrSize
unsigned long	myMaxParamSize
Protected Attributes inherited from DtRtiMsg
DtTransportHandle	myTransportType
DtOrderHandle	myOrderType
DtRtiApiTime *	myFedTime
bool	myTimeIsValid
bool	myConstrained
bool	myAllowedDuringSave
unsigned long	mySerialNumber
unsigned long	myServiceCallNumber
unsigned long	myTriggerMessage

Static Protected Attributes
static bool	theChannelIncluded
Static Protected Attributes inherited from DtRtiMsg
static bool	theUse32BitsForValueSize
static bool	theSmartForwardingEnabled

Additional Inherited Members
Static Public Attributes inherited from DtRtiMsg
static unsigned long	theDefaultRegionSetHandle
static const DtRtiApiVariableLengthData	theDefaultTag

Detailed Description

DtInteractionMsg is a message type that represents an HLA Interaction.

Constructor & Destructor Documentation

DtInteractionMsg::DtInteractionMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

virtual DtInteractionMsg::~DtInteractionMsg ( )

virtual

Destructor.

Member Function Documentation

virtual void DtInteractionMsg::adjustBufferForParams ( const DtPhvps &  params )

protectedvirtual

Adjust size/bytes for the network rep of the avList.

virtual unsigned long DtInteractionMsg::channel ( ) const

virtual

virtual int DtInteractionMsg::channelFieldSize ( ) const

protectedvirtual

Returns size of channel field.

bool DtInteractionMsg::channelIncluded ( )

inlinestatic

References theChannelIncluded.

virtual DtNetU32* DtInteractionMsg::channelPtr ( ) const

protectedpure virtual

Returns pointer to the channel in the netMsg.

Implemented in DtInteractionRoMsg.

virtual void DtInteractionMsg::fillFromNetBigParams ( const DtNetBigParams *  netRepParams, DtPhvps &  params, bool  useMsgMemory, DtInteractionClassInfo const *  classInfo = NULL  ) const

protectedvirtual

Fill the given parameter set with the message's parameters Supports parameter values > 64K Parameter value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed attributes if class info is provided otherwise gets all attributes in message.

virtual void DtInteractionMsg::fillFromNetParams ( const DtNetParams *  netRepParams, DtPhvps &  params, bool  useMsgMemory, DtInteractionClassInfo const *  classInfo = NULL  ) const

protectedvirtual

Fill the given parameter set with the message's parameters Parameter value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed attributes if class info is provided otherwise gets all attributes in message.

virtual void DtInteractionMsg::fillNetBigParams ( const DtPhvps &  theParameters, DtNetBigParams *  netRepParams  )

protectedvirtual

Supports parameter values > 64K.

virtual void DtInteractionMsg::fillNetParams ( const DtPhvps &  theParameters, DtNetParams *  netRepParams  )

protectedvirtual

Fill message with given parameter set.

virtual void DtInteractionMsg::getParams ( DtPhvps &  params, bool  useMsgMemory, DtInteractionClassInfo const *  classInfo = NULL  ) const

virtual

Parameter value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed parameters if class info is provided otherwise gets all parameters in message.

virtual DtInteractionClassHandle DtInteractionMsg::handle ( ) const

pure virtual

Implemented in DtInteractionRoMsg.

virtual DtNetBigParams* DtInteractionMsg::netBigParams ( )

protectedpure virtual

Returns pointer to the network rep of the pvList.

Supports big attribute values > 64K

Implemented in DtInteractionRoMsg.

virtual DtNetParams* DtInteractionMsg::netParams ( )

protectedpure virtual

Returns pointer to the network rep of the pvList.

Implemented in DtInteractionRoMsg.

virtual DtNetBigParamValue* DtInteractionMsg::nextNetBigParam ( char *  netParamTail ) const

protectedvirtual

Given the tail end of the current parameter, return the pointer to next parameter header in the network rep.

Supports big attribute values > 64K

virtual DtNetParamValue* DtInteractionMsg::nextNetParam ( char *  netParamTail ) const

protectedvirtual

Given the tail end of the current parameter, return the pointer to next parameter header in the network rep.

virtual unsigned long DtInteractionMsg::numParams ( ) const

virtual

Get number of parameters.

virtual DtObjectInstanceHandle DtInteractionMsg::objectHandle ( ) const

pure virtual

Implemented in DtInteractionRoMsg.

virtual int DtInteractionMsg::paramAlignPaddingSize ( unsigned long  offset ) const

protectedvirtual

Returns size of param list alignment padding.

DtInteractionMsg * DtInteractionMsg::self ( ) const

inlineprotectedvirtual

Returns pointer to the serial number in the netMsg.

Casts away const-ness

virtual void DtInteractionMsg::setChannel ( unsigned long  handleValue )

virtual

Set/Get DDM channel.

static void DtInteractionMsg::setChannelIncluded ( bool  includeChannel )

static

Set/Get flag to include DDM channel identifier.

virtual void DtInteractionMsg::setHandle ( DtInteractionClassHandle  hand )

pure virtual

Set/Get handle.

Implemented in DtInteractionRoMsg.

virtual void DtInteractionMsg::setObjectHandle ( DtInteractionClassHandle  hand )

pure virtual

Set/Get object instance handle.

Implemented in DtInteractionRoMsg.

virtual void DtInteractionMsg::setParams ( const DtPhvps &  theParameters, bool  adjustBufferSize = true  )

virtual

Set/Get parameters (adjust buffer size if not pre-allocated for this data)

virtual void DtInteractionMsg::setTag ( DtRtiApiTagConstRef  tag, bool  adjustBufferSize = true  )

virtual

Set/Get tag (adjust buffer size if not pre-allocated for this data)

virtual void DtInteractionMsg::setTagSize ( int  size )

protectedpure virtual

Set/Get tag size.

Implemented in DtInteractionRoMsg.

virtual unsigned long DtInteractionMsg::sizeNeededForNetParam ( unsigned long  paramOffset, unsigned long  paramSize  ) const

protectedvirtual

Returns the size the network representation will consume.

virtual unsigned long DtInteractionMsg::sizeNeededForNetParams ( unsigned long  paramOffset, const DtPhvps &  params  ) const

protectedvirtual

Returns the size the network representation will consume.

virtual DtRtiApiTagConstRef DtInteractionMsg::tag ( ) const

virtual

virtual int DtInteractionMsg::tagFieldSize ( ) const

protectedvirtual

Returns size of tag field.

virtual char* DtInteractionMsg::tagPtr ( )

protectedpure virtual

Returns pointer to the tag in the netMsg.

Implemented in DtInteractionRoMsg.

virtual int DtInteractionMsg::tagSize ( ) const

protectedpure virtual

Implemented in DtInteractionRoMsg.

Member Data Documentation

unsigned long DtInteractionMsg::myMaxParamSize

protected

int DtInteractionMsg::myParamHdrAlignment

protected

int DtInteractionMsg::myParamHdrSize

protected

int DtInteractionMsg::myParamListHdrSize

protected

DtRtiApiTagPtr DtInteractionMsg::myTag

protected

bool DtInteractionMsg::theChannelIncluded

staticprotected

Referenced by channelIncluded().

---

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

• interactMsg.h