DtRtiMsg Class Reference

DtRtiMsg is the base class for messages between RTI components. More...

Inherits DtBaseMsg.

Inherited by DtAbortRestoreMsg, DtAliveMsg, DtChangeLatencyTestModeMsg, DtConnectConfirmMsg, DtConnectMsg, DtConnectToForwarderMsg, DtCreateMsg, DtCreateResponseMsg, DtDeleteMsg, DtDesignatedFederateMsg, DtDestroyMsg, DtDestroyResponseMsg, DtDiscObjMsg, DtEnableDisableNetworkTestingMsg, DtFedAmbCallbackMsg, DtFomModuleDistributionMsg, DtFomModuleRequestMsg, DtForwarderConnectionLostMsg, DtForwarderCounterMsg, DtForwarderNodeInfoMsg, DtForwarderPingMsg, DtForwarderPortMsg, DtForwarderResignMsg, DtInteractionMsg, DtJoinConfirmMsg, DtJoinLightWeightMsg, DtJoinMsg, DtJoinResponseMsg, DtLatencyReportMsg, DtListFederationsMsg, DtLocDelMsg, DtMacAddrMsg, DtMcastConfigureMsg, DtMulticastDiscoveryMsg, DtMultiNameReservedMsg, DtMultiRegObjMsg, DtNameReservedMsg, DtNetworkMapReqMsg, DtNetworkMapRspMsg, DtNullMsg, DtOwnershipMsg, DtPartnerFederateMsg, DtPubInterMsg, DtPubObjMsg, DtQueryInterTransportMsg, DtQueryRestoreStatusMsg, DtQuerySaveStatusMsg, DtQueryTransportMsg, DtQueueFullMsg, DtReconnectMsg, DtRegObjMsg, DtReleaseMultiNameMsg, DtReportFederationsMsg, DtReqDiscObjMsg, DtRequestMsg, DtReserveMultiNameMsg, DtReserveNameMsg, DtResignDirectiveMsg, DtResignMsg, DtRestoreBegunMsg, DtRestoreInitiateMsg, DtRestoreReplyMsg, DtRidTestRequestMsg, DtRtiExecConnectMsg, DtRtiExecHandshakeMsg, DtRtiExecShutdownForwarderMsg, DtRtiTemplateMsg, DtSaveMsg, DtSaveResponseMsg, DtSmEnrollmentMsg, DtSubInterMsg, DtSubObjMsg, DtSyncPointMsg, DtSyncPointQueryMsg, DtTestMgrStatusMsg, DtTransferRidParamsMsg, DtUnpubInterMsg, DtUnpubObjMsg, DtUnsubInterMsg, DtUnsubObjMsg, and DtUpdateMsg.

Collaboration diagram for DtRtiMsg:

Public Member Functions
virtual	~DtRtiMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const =0
	Return a copy/empty object of the same type as this.
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.
virtual DtNetMsgHeader *	netHeader () const
	Get header of network representation.
virtual int	version () const
	Return the message version.
virtual bool	isValidVersion () const
	Returns bool: message version is valid?
virtual void	setFedEx (const MAKRti::DtString &name)
	All RTI messages contain information to identify which federation execution the message applies to.
virtual void	setFedEx (int handle)
	Set federation execution identifier as a handle.
virtual bool	isForExec (const MAKRti::DtString &execName, int execHandle) const
	Returns true if the current message belongs to the indicated federation execution, false otherwise.
virtual DtRtiMsgKind	msgKind () const
	Get the message kind.
virtual const char *	kindString () const
	Returns the message kind string name.
virtual bool	isConstrained () const
	Return boolean: message type can be time constrained?
virtual bool	isAllowedDuringSave () const
	Return boolean: message type can be processed during save?
virtual void	setTime (const RTI::FedTime &time)
	Set/Get time Used in timestamped messages.
virtual RTI::FedTime const *	time (DtLogicalTimeFactory *fedTimeFactory) const
virtual bool	hasTime () const
	Returns true if time field is valid.
virtual void	setSerialNumber (unsigned long serialNumberValue)
	Set/Get event retraction serial number Used in timestamped messages.
virtual unsigned long	serialNumber () const
virtual void	setTransportType (DtTransportHandle type)
	Set/Get transport type.
virtual DtTransportHandle	transportType () const
virtual DtOrderHandle	orderType () const
	This base implementation always returns recieve order.
virtual bool	isMetadataPresent () const
	Test if metadata has been added to a DtRtiMsg object.
virtual bool	addMetadata (caddr_t *mtdAddr, unsigned int size, unsigned int *alignPad, unsigned int *headerPad=NULL)
	Allocate space for next block of metadata.
virtual void	removeMetadata (unsigned int size)
	Update the size of the message when metadata has been removed.
bool	isInteractionMsgType () const
	Utility functions, check the message type against known interaciton/update message types.
bool	isUpdateMsgType () const
virtual void	print (DtLogicalTimeFactory *logicalTimeFactory) const
	Printing functions.
virtual void	printHeader (DtLogicalTimeFactory *logicalTimeFactory) const
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
virtual void	printTime (const char *label, RTI::FedTime const *timeValue) const
	Print the given time.
virtual void	printInterval (const char *label, RTI::FedTime const *intervalValue) const
	Print the interval.
virtual int	status () const
	Returns MSG_STATUS_OK if OK, a reason enumeration otherwise.
virtual const MAKRti::DtString	fedExName () const
	These two functions should be avoided in favor of isForExec().
virtual int	fedExHandle () const
	Get the federation execution identifier as a handle Returns 0 if the identifier is being represented as a name.
virtual void	setFederateHandle (DtFederateHandle handle)
	Set/Get federate handle.
virtual DtFederateHandle	federateHandle () const
	Set/Get federate handle.
virtual void	setSequenceNumber (unsigned long value)
	Set/Get message sequence number.
virtual unsigned long	sequenceNumber () const
	Set/Get message sequence number.
virtual void	setServiceCallNumber (unsigned long value)
	Set/Get service call number.
virtual unsigned long	serviceCallNumber () const
	Set/Get service call number.
virtual void	setTriggerMessageNumber (unsigned long value)
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).
virtual unsigned long	triggerMessageNumber () const
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).

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

Static Public Attributes
static unsigned long	theDefaultRegionSetHandle
static const char *	theDefaultTag

Protected Member Functions
	DtRtiMsg ()
	Constructor.
virtual DtRtiMsgKind	internalDtRtiMsgKind ()=0
virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes.
void	initDtRtiMsg (int size, DtRtiMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual.
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.
virtual void	adjustBytes (void *address, int numBytes)
	Adjust the numBytes starting at the indicated addres.

Protected Attributes
DtTransportHandle	myTransportType
DtOrderHandle	myOrderType
RTI::FedTime *	myFedTime
bool	myTimeIsValid
bool	myConstrained
bool	myAllowedDuringSave
unsigned long	mySerialNumber
unsigned long	myServiceCallNumber
unsigned long	myTriggerMessage

Static Protected Attributes
static bool	theUse32BitsForValueSize
static bool	theSmartForwardingEnabled

Detailed Description

DtRtiMsg is the base class for messages between RTI components.

Constructor & Destructor Documentation

virtual DtRtiMsg::~DtRtiMsg ( )

virtual

Destructor.

DtRtiMsg::DtRtiMsg ( )

protected

Constructor.

Member Function Documentation

virtual bool DtRtiMsg::addMetadata ( caddr_t *  mtdAddr, unsigned int  size, unsigned int *  alignPad, unsigned int *  headerPad = NULL  )

virtual

Allocate space for next block of metadata.

Start address is returned in mtdAddr. Alignment indicated in alignPad and amount of padding needed to align metadata returned in the same variable. If an extra byte is needed to align the header after the payload the headerPad argument will be set if the pointer is not NULL. Return value indicates whether this is the first metadata added to the message.

void DtRtiMsg::adjustBytes ( int  offset, int  numBytes  )

inlineprotectedvirtual

Adjust numBytes bytes at the indicated offset in the net rep.

Uses insertBytes or deleteBytes based on sign of numBytes

References rti1516e::insertBytes().

void DtRtiMsg::adjustBytes ( void *  address, int  numBytes  )

inlineprotectedvirtual

Adjust the numBytes starting at the indicated addres.

Assumes that address falls within the net rep. Uses insertBytes or deleteBytes based on sign of numBytes

References rti1516e::insertBytes().

virtual DtRtiMsg* DtRtiMsg::clone ( bool  copy = true ) const

pure virtual

Return a copy/empty object of the same type as this.

NOTE: The transport type is not carried in the network representation used to make clones; therefore, it must be set after the clone is made

Implemented in DtForwarderNodeInfoMsg, DtOwnershipMsg, DtJoinResponseMsg, DtSyncPointMsg, DtTestMgrStatusMsg, DtRequestMsg, DtJoinMsg, DtResignMsg, DtFedAmbCallbackMsg, DtMcastConfigureMsg, DtMulticastDiscoveryMsg, DtCreateResponseMsg, DtLatencyReportMsg, DtQueryTransportMsg, DtSmEnrollmentMsg, DtChangeLatencyTestModeMsg, DtRestoreInitiateMsg, DtSaveTimeMsg, DtRestoreReplyMsg, DtSaveFinishedMsg, DtSyncPointQueryMsg, DtJoinConfirmMsg, DtRestoreEndMsg, DtForwarderCounterMsg, DtPartnerFederateMsg, DtDeleteRoMsg, DtFomModuleRequestMsg, DtSaveResponseMsg, DtUpdateRoMsg, DtCreateMsg, DtRtiExecHandshakeMsg, DtForwarderPortMsg, DtReconnectMsg, DtConnectToForwarderMsg, DtDestroyMsg, DtForwarderPingMsg, DtForwarderResignMsg, DtJoinLightWeightMsg, DtRestoreBegunMsg, DtDestroyResponseMsg, DtInteractionRoMsg, DtLocDelMsg, DtMacAddrMsg, DtRegObjMsg, DtMultiNameReservedMsg, DtNameReservedMsg, DtQueryInterTransportMsg, DtReportFederationsMsg, DtDiscObjMsg, DtRtiExecConnectMsg, DtNetworkMapReqMsg, DtNetworkMapRspMsg, DtResignDirectiveMsg, DtRidTestRequestMsg, DtSubObjMsg, DtTransferRidParamsMsg, DtConnectMsg, DtEnableDisableNetworkTestingMsg, DtPubObjMsg, DtReleaseMultiNameMsg, DtReserveMultiNameMsg, DtReserveNameMsg, DtUnsubObjMsg, DtConnectConfirmMsg, DtFomModuleDistributionMsg, DtRestoreCompleteMsg, DtRestoreRequestMsg, DtRestoreMsg, DtSaveCompleteMsg, DtSaveInitiateConstrainedMsg, DtSaveInitiateMsg, DtSaveRequestMsg, DtUnpubObjMsg, DtDeleteSocketMsg, DtDesignatedFederateMsg, DtForwarderConnectionLostMsg, DtMultiRegObjMsg, DtReqDiscObjMsg, DtUnpubInterMsg, DtUnsubInterMsg, DtFomModuleDistExecMsg, DtListFederationsMsg, DtPubInterMsg, DtSubInterMsg, DtDisconnectMsg, DtRtiExecDisconnectMsg, DtQueueFullMsg, DtAliveMsg, DtRtiExecShutdownForwarderMsg, DtQueryRestoreStatusMsg, DtQuerySaveStatusMsg, DtAbortRestoreMsg, DtSaveBegunMsg, DtAbortSaveMsg, DtInitiatedSaveMsg, and DtSaveTimeAdvanceMsg.

virtual DtRtiMsg* DtRtiMsg::cloneWithTransport ( bool  copy = true ) const

virtual

Return a copy/empty object of the same type as this using clone and set the transport type from the host message.

DtFederateHandle DtRtiMsg::federateHandle ( ) const

inlinevirtual

Set/Get federate handle.

Reimplemented in DtReconnectMsg.

References DtNetMsgHeader::fedHandle, and netHeader().

static DtFederateHandle DtRtiMsg::federateHandle ( const void *  buffer )

static

Extracts the message federate handle form the given buffer.

virtual int DtRtiMsg::fedExHandle ( ) const

virtual

Get the federation execution identifier as a handle Returns 0 if the identifier is being represented as a name.

static unsigned int DtRtiMsg::fedExHandle ( const void *  buffer )

static

Extracts the message fedEx handle form the given buffer (0 if lightweight fedEx name)

virtual const MAKRti::DtString DtRtiMsg::fedExName ( ) const

virtual

These two functions should be avoided in favor of isForExec().

They provide detail about how a federation execution identifier has been encoded in the message. Get the federation execution identifier as a string Returns an empty string if the identifier is being represented as a handle.

static unsigned char DtRtiMsg::flags ( const void *  buffer )

static

Extracts the message flags form the given buffer.

virtual bool DtRtiMsg::hasTime ( ) const

virtual

Returns true if time field is valid.

void DtRtiMsg::initDtRtiMsg ( int  size, DtRtiMsgKind  msgKindVal, DtBufferPtr  buffer  )

protected

Called by ctor, so not virtual.

void DtRtiMsg::initDtRtiMsg ( const void *  initial, int  size, DtBufferPtr  buffer  )

protected

void DtRtiMsg::initDtRtiMsg ( const DtNetMsgHeader *  header, DtBufferPtr  buffer  )

protected

virtual DtRtiMsgKind DtRtiMsg::internalDtRtiMsgKind ( )

protectedpure virtual

Implemented in DtJoinResponseMsg, DtSyncPointMsg, DtOwnershipMsg, DtForwarderNodeInfoMsg, DtJoinMsg, DtRequestMsg, DtCreateMsg, DtQueryTransportMsg, DtResignMsg, DtChangeLatencyTestModeMsg, DtFomModuleDistributionMsg, DtJoinLightWeightMsg, DtConnectConfirmMsg, DtTestMgrStatusMsg, DtRtiExecHandshakeMsg, DtMulticastDiscoveryMsg, DtLatencyReportMsg, DtMcastConfigureMsg, DtSyncPointQueryMsg, DtForwarderCounterMsg, DtCreateResponseMsg, DtRtiExecConnectMsg, DtDiscObjMsg, DtFomModuleRequestMsg, DtRestoreReplyMsg, DtQueryInterTransportMsg, DtSaveResponseMsg, DtRegObjMsg, DtSubObjMsg, DtJoinConfirmMsg, DtReconnectMsg, DtUpdateRoMsg, DtInteractionRoMsg, DtConnectToForwarderMsg, DtDeleteRoMsg, DtMultiNameReservedMsg, DtMultiRegObjMsg, DtPartnerFederateMsg, DtRestoreBegunMsg, DtForwarderPortMsg, DtReportFederationsMsg, DtSmEnrollmentMsg, DtNameReservedMsg, DtDestroyResponseMsg, DtReleaseMultiNameMsg, DtReserveMultiNameMsg, DtForwarderPingMsg, DtForwarderResignMsg, DtSaveTimeMsg, DtMacAddrMsg, DtResignDirectiveMsg, DtNetworkMapRspMsg, DtPubObjMsg, DtTransferRidParamsMsg, DtConnectMsg, DtUnsubObjMsg, DtDestroyMsg, DtForwarderConnectionLostMsg, DtReqDiscObjMsg, DtUnpubObjMsg, DtLocDelMsg, DtUnsubInterMsg, DtEnableDisableNetworkTestingMsg, DtNetworkMapReqMsg, DtRestoreEndMsg, DtRestoreInitiateMsg, DtSaveFinishedMsg, DtSubInterMsg, DtReserveNameMsg, DtUnpubInterMsg, DtPubInterMsg, DtDesignatedFederateMsg, DtRidTestRequestMsg, DtListFederationsMsg, DtSaveCompleteMsg, DtSaveRequestMsg, DtSaveMsg, DtAliveMsg, DtRtiExecShutdownForwarderMsg, DtFomModuleDistExecMsg, DtQueryRestoreStatusMsg, DtQuerySaveStatusMsg, DtRestoreCompleteMsg, DtAbortRestoreMsg, DtRtiTemplateMsg, DtQueueFullMsg, DtRestoreRequestMsg, DtRestoreMsg, DtSaveInitiateConstrainedMsg, DtSaveInitiateMsg, DtDeleteSocketMsg, DtDisconnectMsg, DtRtiExecDisconnectMsg, DtFedAmbCallbackMsg, DtSaveBegunMsg, DtAbortSaveMsg, DtInitiatedSaveMsg, DtSaveTimeAdvanceMsg, and DtNullMsg.

virtual bool DtRtiMsg::isAllowedDuringSave ( ) const

virtual

Return boolean: message type can be processed during save?

virtual bool DtRtiMsg::isConstrained ( ) const

virtual

Return boolean: message type can be time constrained?

virtual bool DtRtiMsg::isForExec ( const MAKRti::DtString &  execName, int  execHandle  ) const

virtual

Returns true if the current message belongs to the indicated federation execution, false otherwise.

If you are not using an rtiexec, use a handle of zero.

bool DtRtiMsg::isInteractionMsgType

(

)

const

Utility functions, check the message type against known interaciton/update message types.

virtual bool DtRtiMsg::isMetadataPresent ( ) const

virtual

Test if metadata has been added to a DtRtiMsg object.

bool DtRtiMsg::isUpdateMsgType

(

)

const

virtual bool DtRtiMsg::isValidVersion ( ) const

virtual

Returns bool: message version is valid?

virtual const char* DtRtiMsg::kindString ( ) const

virtual

Returns the message kind string name.

static const char* DtRtiMsg::kindString ( const void *  buffer )

static

Extracts the message kind from the given buffer and returns its string name.

static const char* DtRtiMsg::kindToString ( DtRtiMsgKind  kind )

static

Returns the name of the message, by kind enumeration.

Referenced by DtForwarderNodeInfoFilter::applyFilter(), DtFederateCounterFilter::applyFilter(), DtForwarderPingFilter::applyFilter(), DtRtiExecHandshakeFilter::applyFilter(), DtNetworkMapFilter::applyFilter(), DtUpdateInterDestinationFilter< ParentClass >::applyFilter(), DtFederateConnectFilter< ParentClass >::applyFilter(), DtMulticastListenDropFilter< ParentClass >::applyFilter(), DtFederateJoinResignFilter< ParentClass >::applyFilter(), DtForwarderFedexMsgFilter::applyFilter(), and DtRtiExecConnectionFilter< DtRtiExecHandshakeProcessor >::applyFilter().

static unsigned long DtRtiMsg::metadataSize ( const void *  buffer )

static

Extracts the message metadata size form the given buffer.

DtRtiMsgKind DtRtiMsg::msgKind ( ) const

inlinevirtual

Get the message kind.

References netHeader().

Referenced by DtForwarderNodeInfoFilter::applyFilter().

static const DtRtiMsgKind DtRtiMsg::msgKind ( const void *  buffer )

static

Extracts the message kind from the given buffer.

DtNetMsgHeader * DtRtiMsg::netHeader ( ) const

inlinevirtual

Get header of network representation.

Referenced by DtNetMsgHeaderParam::endPtr(), federateHandle(), and msgKind().

const DtNetMsgHeader * DtRtiMsg::netHeader ( const void *  buffer )

inlinestatic

Extracts the header network representation from the buffer.

virtual DtOrderHandle DtRtiMsg::orderType ( ) const

virtual

This base implementation always returns recieve order.

virtual void DtRtiMsg::print ( DtLogicalTimeFactory *  logicalTimeFactory ) const

virtual

Printing functions.

virtual void DtRtiMsg::printData ( DtLogicalTimeFactory *  logicalTimeFactory ) const

virtual

Reimplemented in DtJoinResponseMsg, DtSyncPointMsg, DtOwnershipMsg, DtJoinMsg, DtRequestMsg, DtForwarderNodeInfoMsg, DtCreateMsg, DtQueryTransportMsg, DtResignMsg, DtFomModuleDistributionMsg, DtJoinLightWeightMsg, DtConnectConfirmMsg, DtMulticastDiscoveryMsg, DtMcastConfigureMsg, DtSyncPointQueryMsg, DtRtiExecConnectMsg, DtRtiExecHandshakeMsg, DtDiscObjMsg, DtFomModuleRequestMsg, DtForwarderCounterMsg, DtUpdateRoMsg, DtSaveResponseMsg, DtFedAmbCallbackMsg, DtRegObjMsg, DtReconnectMsg, DtSubObjMsg, DtJoinConfirmMsg, DtQueryInterTransportMsg, DtCreateResponseMsg, DtDeleteRoMsg, DtInteractionRoMsg, DtMultiNameReservedMsg, DtMultiRegObjMsg, DtRestoreBegunMsg, DtReportFederationsMsg, DtSaveTimeMsg, DtSmEnrollmentMsg, DtNameReservedMsg, DtDestroyResponseMsg, DtForwarderPingMsg, DtForwarderResignMsg, DtRestoreReplyMsg, DtTestMgrStatusMsg, DtNetworkMapRspMsg, DtResignDirectiveMsg, DtSaveMsg, DtPubObjMsg, DtForwarderConnectionLostMsg, DtNetworkMapReqMsg, DtUnsubObjMsg, DtDestroyMsg, DtLatencyReportMsg, DtReqDiscObjMsg, DtTransferRidParamsMsg, DtUnpubObjMsg, DtChangeLatencyTestModeMsg, DtLocDelMsg, DtPartnerFederateMsg, DtRestoreInitiateMsg, DtUnsubInterMsg, DtEnableDisableNetworkTestingMsg, DtRtiTemplateMsg, DtSubInterMsg, DtConnectMsg, DtReserveNameMsg, DtRidTestRequestMsg, DtReleaseMultiNameMsg, DtReserveMultiNameMsg, DtSaveCompleteMsg, DtForwarderPortMsg, DtUnpubInterMsg, DtConnectToForwarderMsg, DtPubInterMsg, DtMacAddrMsg, DtSaveRequestMsg, DtDesignatedFederateMsg, DtListFederationsMsg, DtFomModuleDistExecMsg, DtAliveMsg, DtRtiExecShutdownForwarderMsg, DtQueryRestoreStatusMsg, DtQuerySaveStatusMsg, DtAbortRestoreMsg, DtSaveBegunMsg, DtAbortSaveMsg, and DtNullMsg.

virtual void DtRtiMsg::printHeader ( DtLogicalTimeFactory *  logicalTimeFactory ) const

virtual

virtual void DtRtiMsg::printInterval ( const char *  label, RTI::FedTime const *  intervalValue  ) const

virtual

Print the interval.

virtual void DtRtiMsg::printTime ( const char *  label, RTI::FedTime const *  timeValue  ) const

virtual

Print the given time.

virtual void DtRtiMsg::removeMetadata ( unsigned int  size )

virtual

Update the size of the message when metadata has been removed.

Does not do the actual removing (that's done by DtRtiMetadata::remove())

virtual unsigned long DtRtiMsg::sequenceNumber ( ) const

virtual

Set/Get message sequence number.

static unsigned long DtRtiMsg::sequenceNumber ( const void *  buffer )

static

Extracts the message sequence number form the given buffer.

virtual unsigned long DtRtiMsg::serialNumber ( ) const

virtual

virtual unsigned long DtRtiMsg::serviceCallNumber ( ) const

virtual

Set/Get service call number.

static void DtRtiMsg::setDefaultRegionSet ( unsigned long  defaultRegionSet )

static

Set the default region set handle.

virtual void DtRtiMsg::setFederateHandle ( DtFederateHandle  handle )

virtual

Set/Get federate handle.

Reimplemented in DtReconnectMsg.

virtual void DtRtiMsg::setFedEx ( const MAKRti::DtString &  name )

virtual

All RTI messages contain information to identify which federation execution the message applies to.

The federation execution is identified differently depending on whether or not an rtiexec is being used. When using an rtiexec, use setFedEx(int fedExHandle) to add a federation execution identifier to a message, passing the handle you received from the rtiexec in a joinResponse message when you joined. When not using an rtiexec, use setFedEx(const MAKRti::DtString fedExName), passing the name of the federation execution. In this case, the first three letters of the name will be used as the identifier. In either case, use isForExec() to find out if a received message is for a particular federation execution. Pass the federation execution name and the handle (if using an rtiexec). Set federation execution identifier as a string

virtual void DtRtiMsg::setFedEx ( int  handle )

virtual

Set federation execution identifier as a handle.

virtual void DtRtiMsg::setSequenceNumber ( unsigned long  value )

virtual

Set/Get message sequence number.

virtual void DtRtiMsg::setSerialNumber ( unsigned long  serialNumberValue )

virtual

Set/Get event retraction serial number Used in timestamped messages.

Network data must be maintained by derived messages

virtual void DtRtiMsg::setServiceCallNumber ( unsigned long  value )

virtual

Set/Get service call number.

static void DtRtiMsg::setSmartForwardingEnabled ( bool  enabled )

static

Set/Get is SmartForwarding enabled?

virtual void DtRtiMsg::setTime ( const RTI::FedTime &  time )

virtual

Set/Get time Used in timestamped messages.

Network data must be maintained by derived messages

Reimplemented in DtSaveMsg.

virtual void DtRtiMsg::setTransportType ( DtTransportHandle  type )

virtual

Set/Get transport type.

virtual void DtRtiMsg::setTriggerMessageNumber ( unsigned long  value )

virtual

Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).

static void DtRtiMsg::setUse32BitsForValueSize ( bool  use32BitsForValueSizeEnabled )

static

Set/Get flag to enable use of 32 bit size field for attribute/parameter values.

virtual void DtRtiMsg::sizeChanged ( int  size )

protectedvirtual

Called whenever size is changed using changeSize, or insert/deleteBytes.

static bool DtRtiMsg::smartForwardingEnabled ( )

static

int DtRtiMsg::status ( ) const

inlinevirtual

Returns MSG_STATUS_OK if OK, a reason enumeration otherwise.

References MSG_STATUS_OK.

virtual RTI::FedTime const* DtRtiMsg::time ( DtLogicalTimeFactory *  fedTimeFactory ) const

virtual

Reimplemented in DtSaveMsg.

static unsigned long DtRtiMsg::totalSize ( const void *  buffer )

static

Extracts the message total size form the given buffer.

virtual DtTransportHandle DtRtiMsg::transportType ( ) const

virtual

virtual unsigned long DtRtiMsg::triggerMessageNumber ( ) const

virtual

Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).

static bool DtRtiMsg::use32BitsForValueSize ( )

static

virtual int DtRtiMsg::version ( ) const

virtual

Return the message version.

static unsigned int DtRtiMsg::version ( const void *  buffer )

static

Extracts the message version form the given buffer.

Member Data Documentation

bool DtRtiMsg::myAllowedDuringSave

protected

bool DtRtiMsg::myConstrained

protected

RTI::FedTime* DtRtiMsg::myFedTime

protected

DtOrderHandle DtRtiMsg::myOrderType

protected

unsigned long DtRtiMsg::mySerialNumber

protected

unsigned long DtRtiMsg::myServiceCallNumber

protected

bool DtRtiMsg::myTimeIsValid

protected

DtTransportHandle DtRtiMsg::myTransportType

protected

unsigned long DtRtiMsg::myTriggerMessage

protected

unsigned long DtRtiMsg::theDefaultRegionSetHandle

static

const char* DtRtiMsg::theDefaultTag

static

bool DtRtiMsg::theSmartForwardingEnabled

staticprotected

bool DtRtiMsg::theUse32BitsForValueSize

staticprotected

---

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

• rtiMsg.h