DtInteractionRoMsg Class Reference

Message for sending receive order interaciotns. More...

Inheritance diagram for DtInteractionRoMsg:

Collaboration diagram for DtInteractionRoMsg:

Public Member Functions
	DtInteractionRoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtInteractionRoMsg (DtInteractionClassHandle theInteraction, const DtPhvps &theParameters, char const *theTag, unsigned long channel, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtInteractionRoMsg (const DtNetInteractionMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtInteractionRoMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (DtInteractionClassHandle theInteraction, const DtPhvps &theParameters, char const *theTag, unsigned long channel)
	Set all fields simultaneously.
virtual void	setHandle (DtInteractionClassHandle hand)
	Set/Get handle.
virtual DtInteractionClassHandle	handle () const
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print the data section.
Public Member Functions inherited from DtInteractionMsg
	DtInteractionMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtInteractionMsg ()
	Destructor.
virtual void	setChannel (unsigned long handleValue)
	Set/Get DDM channel.
virtual unsigned long	channel () const
virtual void	setTag (char const *tag)
	Set/Get tag.
virtual char const *	tag () const
virtual void	setParams (const DtPhvps &theParameters, bool checkBufferSize=true)
	Set/Get parameters.
virtual void	getParams (DtPhvps &params, bool useMsgMemory, DtInteractionClassInfo *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.
virtual unsigned long	numParams () const
	Get number of parameters.
Public Member Functions inherited from DtRtiMsg
virtual	~DtRtiMsg ()
	Destructor.
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	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 DtRtiMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators.
static DtRtiMsg *	create (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtConnectionMgr *conn, DtInteractionCb cb, void *usr, bool isMomCallback=false)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtInteractionCb cb, void *usr, bool isMomCallback=false)
Static Public Member Functions inherited from DtInteractionMsg
static void	setChannelIncluded (bool includeChannel)
	Set/Get flag to include DDM channel identifier.
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.
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 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 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 ()

Protected Member Functions
virtual DtNetParams *	netParams ()
	Returns pointer to the network rep of the pvList.
virtual DtNetBigParams *	netBigParams ()
	Returns pointer to the network rep of the pvList.
virtual DtNetInteractionMsg *	netInterRoMsg ()
	The network representation.
virtual const DtNetInteractionMsg *	netInterRoMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Interaction Msg.
virtual int	minSize (const DtPhvps *params=NULL, char const *theTag=NULL) const
	Returns minimum size of a message, including header, time, and tag.
virtual void	setTagSize (int size)
	Set/Get tag size.
virtual int	tagSize () const
virtual DtNetU32 *	channelPtr () const
	Returns pointer to the channel in the netMsg.
virtual char *	tagPtr ()
	Returns pointer to the tag in the netMsg.
virtual DtInteractionRoMsg *	selfRo () const
	Casts away const-ness.
Protected Member Functions inherited from DtInteractionMsg
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.
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.
virtual void	fillFromNetParams (const DtNetParams *netRepParams, DtPhvps &params, bool useMsgMemory, DtInteractionClassInfo *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.
virtual void	fillFromNetBigParams (const DtNetBigParams *netRepParams, DtPhvps &params, bool useMsgMemory, DtInteractionClassInfo *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.
virtual void	fillNetParams (const DtPhvps &theParameters, DtNetParams *netRepParams)
	Fill message with given parameter set.
virtual void	fillNetBigParams (const DtPhvps &theParameters, DtNetBigParams *netRepParams)
	Supports parameter values > 64K.
virtual void	adjustBufferForParams (const DtPhvps &params)
	Adjust size/bytes for the network rep of the avList.
virtual unsigned long	sizeNeededForNetParam (unsigned long paramOffset, unsigned long paramSize) const
	Returns the size the network representation will consume.
virtual unsigned long	sizeNeededForNetParams (unsigned long paramOffset, const DtPhvps &params) const
	Returns the size the network representation will consume.
virtual int	channelFieldSize () const
	Returns size of channel field.
virtual int	tagFieldSize () const
	Returns size of tag field.
virtual int	paramAlignPaddingSize (unsigned long offset) const
	Returns size of param list alignment padding.
virtual DtInteractionMsg *	self () const
	Returns pointer to the serial number in the netMsg.
Protected Member Functions inherited from DtRtiMsg
	DtRtiMsg ()
	Constructor.
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.

Additional Inherited Members
Static Public Attributes inherited from DtRtiMsg
static unsigned long	theDefaultRegionSetHandle = 0
static const char *	theDefaultTag = NULL
Protected Attributes inherited from DtInteractionMsg
char *	myTag
int	myParamHdrAlignment
int	myParamListHdrSize
int	myParamHdrSize
unsigned long	myMaxParamSize
Static Protected Attributes inherited from DtInteractionMsg
static bool	theChannelIncluded = false

Detailed Description

Message for sending receive order interaciotns.

Constructor & Destructor Documentation

DtInteractionRoMsg::DtInteractionRoMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), and minSize().

Referenced by clone(), and create().

DtInteractionRoMsg::DtInteractionRoMsg	(	DtInteractionClassHandle	theInteraction,
		const DtPhvps &	theParameters,
		char const *	theTag,
		unsigned long	channel,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), DtInteractionMsg::setChannel(), setHandle(), DtInteractionMsg::setParams(), and DtInteractionMsg::setTag().

DtInteractionRoMsg::DtInteractionRoMsg	(	const DtNetInteractionMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtNetInteractionMsg::header, and DtRtiMsg::initDtRtiMsg().

DtInteractionRoMsg::~DtInteractionRoMsg ( )

virtual

Destructor.

Member Function Documentation

void DtInteractionRoMsg::addCallback ( DtConnectionMgr *  conn, DtInteractionCb  cb, void *  usr, bool  isMomCallback = false  )

static

Callback management.

References DtConnectionMgr::addMsgCallback(), DtInteractionMsg::channelIncluded(), DtDdmInteractionRoMsgKind, DtInteractionRoMsgKind, and DtRtiMsg::msgKind().

Referenced by DtInteractionMgr::DtInteractionMgr().

DtNetU32 * DtInteractionRoMsg::channelPtr ( ) const

protectedvirtual

Returns pointer to the channel in the netMsg.

Implements DtInteractionMsg.

References netInterRoMsg(), and DtNetInteractionMsg::tagSize.

Referenced by tagPtr().

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

virtual

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

Implements DtRtiMsg.

References DtInteractionRoMsg(), and netInterRoMsg().

DtRtiMsg * DtInteractionRoMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER )

static

Creators.

References DtInteractionRoMsg().

Referenced by DtDfltMsgFactory::DtDfltMsgFactory().

DtRtiMsg * DtInteractionRoMsg::create ( const DtNetMsgHeader *  initial, DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER  )

static

References DtInteractionRoMsg().

DtInteractionClassHandle DtInteractionRoMsg::handle ( ) const

virtual

Implements DtInteractionMsg.

References DtNetInteractionMsg::handle, and netInterRoMsg().

Referenced by printData().

DtRtiMsgKind DtInteractionRoMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an Interaction Msg.

Implements DtRtiMsg.

References DtInteractionMsg::channelIncluded(), DtDdmInteractionRoMsgKind, and DtInteractionRoMsgKind.

Referenced by DtInteractionRoMsg().

int DtInteractionRoMsg::minSize ( const DtPhvps *  params = NULL, char const *  theTag = NULL  ) const

protectedvirtual

Returns minimum size of a message, including header, time, and tag.

References rti1516e::VariableLengthData::size().

Referenced by DtInteractionRoMsg().

DtNetBigParams * DtInteractionRoMsg::netBigParams ( )

protectedvirtual

Returns pointer to the network rep of the pvList.

Supports big attribute values > 64K

Implements DtInteractionMsg.

References DtInteractionMsg::tagFieldSize(), and tagPtr().

DtNetInteractionMsg * DtInteractionRoMsg::netInterRoMsg ( )

protectedvirtual

The network representation.

Referenced by channelPtr(), clone(), handle(), setHandle(), setTagSize(), and tagSize().

const DtNetInteractionMsg * DtInteractionRoMsg::netInterRoMsg ( ) const

protectedvirtual

DtNetParams * DtInteractionRoMsg::netParams ( )

protectedvirtual

Returns pointer to the network rep of the pvList.

Implements DtInteractionMsg.

References DtInteractionMsg::tagFieldSize(), and tagPtr().

void DtInteractionRoMsg::printData ( DtLogicalTimeFactory *  logicalTimeFactory ) const

virtual

Print the data section.

Reimplemented from DtRtiMsg.

References DtInteractionMsg::channel(), DtInteractionMsg::channelIncluded(), DtInteractionMsg::getParams(), handle(), DtInteractionMsg::numParams(), DtRtiMsg::orderType(), DtInteractionMsg::tag(), and DtRtiMsg::transportType().

void DtInteractionRoMsg::removeCallback ( DtConnectionMgr *  conn, DtInteractionCb  cb, void *  usr, bool  isMomCallback = false  )

static

References DtInteractionMsg::channelIncluded(), DtDdmInteractionRoMsgKind, DtInteractionRoMsgKind, DtRtiMsg::msgKind(), and DtConnectionMgr::removeMsgCallback().

Referenced by DtInteractionMgr::~DtInteractionMgr().

DtInteractionRoMsg * DtInteractionRoMsg::selfRo ( ) const

inlineprotectedvirtual

Casts away const-ness.

void DtInteractionRoMsg::set ( DtInteractionClassHandle  theInteraction, const DtPhvps &  theParameters, char const *  theTag, unsigned long  channel  )

virtual

Set all fields simultaneously.

References DtInteractionMsg::setChannel(), setHandle(), DtInteractionMsg::setParams(), and DtInteractionMsg::setTag().

Referenced by DtInteractionMgr::sendInteractionMsg(), DtFedExec::sendSyncPointReport(), and DtFedExec::sendSyncPointStatusReport().

void DtInteractionRoMsg::setHandle ( DtInteractionClassHandle  hand )

virtual

Set/Get handle.

Implements DtInteractionMsg.

References DtNetInteractionMsg::handle, and netInterRoMsg().

Referenced by DtInteractionRoMsg(), and set().

void DtInteractionRoMsg::setTagSize ( int  size )

protectedvirtual

Set/Get tag size.

Implements DtInteractionMsg.

References netInterRoMsg(), and DtNetInteractionMsg::tagSize.

char * DtInteractionRoMsg::tagPtr ( )

protectedvirtual

Returns pointer to the tag in the netMsg.

Implements DtInteractionMsg.

References DtInteractionMsg::channelFieldSize(), and channelPtr().

Referenced by netBigParams(), and netParams().

int DtInteractionRoMsg::tagSize ( ) const

protectedvirtual

Implements DtInteractionMsg.

References netInterRoMsg(), and DtNetInteractionMsg::tagSize.

---

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

• interRoMsg.h
• interRoMsg.cxx