Inheritance diagram for DtUpdateRoMsg:

Collaboration diagram for DtUpdateRoMsg:

Public Member Functions
	DtUpdateRoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtUpdateRoMsg (DtObjectInstanceHandle objHand, const char objName, DtObjectClassHandle classHand, const DtAhvps &theAttributes, char const theTag, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtUpdateRoMsg (const DtNetUpdateMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtUpdateRoMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (DtObjectInstanceHandle objHand, const char objName, DtObjectClassHandle theClass, const DtAhvps &theAttributes, char const theTag)
	Set all fields simultaneously.
virtual void	setClassHandle (DtObjectClassHandle hand)
	Set/Get handle.
virtual DtObjectClassHandle	classHandle () const
virtual void	setObjHandle (DtObjectInstanceHandle id)
	Set/Get handle.
virtual DtObjectInstanceHandle	objHandle () const
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print the data section.
Public Member Functions inherited from DtUpdateMsg
	DtUpdateMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtUpdateMsg ()
	Destructor.
virtual void	setChannel (unsigned long handleValue)
	Set/Get DDM channel.
virtual unsigned long	channel () const
virtual void	setObjName (const char *name)
	Set/Get name.
virtual const char *	objName () const
virtual void	setTag (char const *tag)
	Set/Get tag.
virtual char const *	tag () const
virtual void	setAttrs (const DtAhvps &theAttributes, bool checkBufferSize=true)
	Set attributes.
virtual void	getAttrs (DtAhvps &attrSetBuff, bool useMsgMemory, DtObjectClassInfo objDesc=NULL, DtHandle regionSetHandle=DtDefaultRegionSetHandle, DtRtiObject obj=NULL, float tolerance=0.0) const
	Get attributes Attribute 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 unsigned long	numAttrs () 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)
	Creator.
static DtRtiMsg *	create (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtConnectionMgr conn, DtUpdateCb cb, void usr)
	Callback management.
static void	removeCallback (DtConnectionMgr conn, DtUpdateCb cb, void usr)
Static Public Member Functions inherited from DtUpdateMsg
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 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 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 DtNetUpdateMsg *	netUpdateRoMsg ()
	The network representation.
virtual const DtNetUpdateMsg *	netUpdateRoMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Update Msg.
virtual int	minSize (const DtAhvps attrs=NULL, const char objName=NULL, char const *theTag=theDefaultTag) const
	Returns minimum size of a message, including header.
virtual void	setNameSize (int size)
	Set/Get name size.
virtual int	nameSize () const
virtual void	setTagSize (int size)
	Set/Get tag size.
virtual int	tagSize () const
virtual DtNetAttrs *	netAttrs ()
	Returns pointer to the network rep of the pvList.
virtual DtNetBigAttrs *	netBigAttrs ()
	Returns pointer to the network rep of the avList.
virtual DtNetU32 *	channelPtr () const
	Returns pointer to the channel in the netMsg.
virtual char *	namePtr ()
	Returns pointer to the name in the netMsg.
virtual char *	tagPtr ()
	Returns pointer to the tag in the netMsg.
virtual DtUpdateRoMsg *	selfRo () const
	Casts away const-ness.
Protected Member Functions inherited from DtUpdateMsg
virtual DtNetAttrValue *	nextNetAttr (char *netAttrTail) const
	Given the tail end of the current attribute, return the pointer to next attribute header in the network rep.
virtual DtNetBigAttrValue *	nextNetBigAttr (char *netAttrTail) const
	Given the tail end of the current attribute, return the pointer to next attribute header in the network rep.
virtual void	fillFromNetAttrs (const DtNetAttrs netRepAttrs, DtAhvps &attrs, bool useMsgMemory, DtObjectClassInfo objDesc=NULL, DtHandle regionSetHandle=DtDefaultRegionSetHandle, DtRtiObject *obj=NULL, float tolerance=0.0) const
	Fill the supplied attribute set with the message's attributes Attribute 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	fillFromNetBigAttrs (const DtNetBigAttrs netAttrs, DtAhvps &attrs, bool useMsgMemory, DtObjectClassInfo objDesc=NULL, DtHandle regionSetHandle=DtDefaultRegionSetHandle, DtRtiObject *obj=NULL, float tolerance=0.0) const
	Fill the supplied attribute set with the message's attributes Supports big attribute values > 64K Attribute 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 Supports big attribute values > 64K.
virtual void	fillNetAttrs (const DtAhvps &theAttributes, DtNetAttrs *netRepAttrs)
	Fill the message with the given attributes.
virtual void	fillNetBigAttrs (const DtAhvps &attrs, DtNetBigAttrs *netAttrs)
	Fill the message with the given attributes Supports big attribute values > 64K.
virtual void	adjustBufferForAttrs (const DtAhvps &attrs)
	Adjust size/bytes for the network rep of the avList.
virtual unsigned long	sizeNeededForNetAttr (unsigned long attrOffset, unsigned long attrSize) const
	Returns the size the network representation will consume.
virtual unsigned long	sizeNeededForNetAttrs (unsigned long offset, const DtAhvps &attrs) const
	Returns the size the network representation will consume.
virtual int	channelFieldSize () const
	Returns size of serial number field.
virtual int	tagFieldSize () const
	Returns size of tag field.
virtual int	nameFieldSize () const
	Returns size of name field.
virtual int	attrAlignPaddingSize (unsigned long offset) const
	Returns size of attr list alignment padding.
virtual DtUpdateMsg *	self () const
	Casts away const-ness.
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 DtUpdateMsg
int	myAttrHdrAlignment
int	myAttrListHdrSize
int	myAttrHdrSize
unsigned long	myMaxAttrSize
Static Protected Attributes inherited from DtUpdateMsg
static bool	theChannelIncluded = false

Constructor & Destructor Documentation

DtUpdateRoMsg::DtUpdateRoMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructor.

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

Referenced by clone(), and create().

DtUpdateRoMsg::DtUpdateRoMsg	(	DtObjectInstanceHandle	objHand,
		const char *	objName,
		DtObjectClassHandle	classHand,
		const DtAhvps &	theAttributes,
		char const *	theTag,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), DtUpdateMsg::setAttrs(), DtUpdateMsg::setChannel(), setClassHandle(), setObjHandle(), DtUpdateMsg::setObjName(), and DtUpdateMsg::setTag().

DtUpdateRoMsg::DtUpdateRoMsg	(	const DtNetUpdateMsg *	netRepMsg,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

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

DtUpdateRoMsg::~DtUpdateRoMsg ( )

virtual

Destructor.

Member Function Documentation

void DtUpdateRoMsg::addCallback	(	DtConnectionMgr *	conn,
		DtUpdateCb	cb,
		void *	usr
	)

static

Callback management.

References DtConnectionMgr::addMsgCallback(), DtUpdateMsg::channelIncluded(), DtDdmUpdateRoMsgKind, DtUpdateRoMsgKind, and DtRtiMsg::msgKind().

Referenced by DtObjectMgr::DtObjectMgr().

DtNetU32 * DtUpdateRoMsg::channelPtr ( ) const

protectedvirtual

Returns pointer to the channel in the netMsg.

Implements DtUpdateMsg.

References DtNetUpdateMsg::nameSize, and netUpdateRoMsg().

Referenced by tagPtr().

DtObjectClassHandle DtUpdateRoMsg::classHandle ( ) const

virtual

Implements DtUpdateMsg.

References DtNetUpdateMsg::handle, and netUpdateRoMsg().

Referenced by printData().

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

virtual

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

Implements DtRtiMsg.

References DtUpdateRoMsg(), and netUpdateRoMsg().

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

static

Creator.

References DtUpdateRoMsg().

Referenced by DtDfltMsgFactory::DtDfltMsgFactory().

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

static

References DtUpdateRoMsg().

DtRtiMsgKind DtUpdateRoMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an Update Msg.

Implements DtRtiMsg.

References DtUpdateMsg::channelIncluded(), DtDdmUpdateRoMsgKind, and DtUpdateRoMsgKind.

Referenced by DtUpdateRoMsg().

int DtUpdateRoMsg::minSize	(	const DtAhvps *	attrs = `NULL`,
		const char *	objName = `NULL`,
		char const *	theTag = `theDefaultTag`
	)		const

protectedvirtual

Returns minimum size of a message, including header.

References rti1516e::VariableLengthData::size().

Referenced by DtUpdateRoMsg().

char * DtUpdateRoMsg::namePtr ( )

protectedvirtual

Returns pointer to the name in the netMsg.

Implements DtUpdateMsg.

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

Referenced by netAttrs(), and netBigAttrs().

int DtUpdateRoMsg::nameSize ( ) const

protectedvirtual

Implements DtUpdateMsg.

References DtNetUpdateMsg::nameSize, and netUpdateRoMsg().

DtNetAttrs * DtUpdateRoMsg::netAttrs ( )

protectedvirtual

Returns pointer to the network rep of the pvList.

Implements DtUpdateMsg.

References DtUpdateMsg::nameFieldSize(), and namePtr().

DtNetBigAttrs * DtUpdateRoMsg::netBigAttrs ( )

protectedvirtual

Returns pointer to the network rep of the avList.

Supports big attribute values > 64K

Implements DtUpdateMsg.

References DtUpdateMsg::nameFieldSize(), and namePtr().

DtNetUpdateMsg * DtUpdateRoMsg::netUpdateRoMsg ( )

protectedvirtual

The network representation.

Referenced by channelPtr(), classHandle(), clone(), nameSize(), objHandle(), setClassHandle(), setNameSize(), setObjHandle(), setTagSize(), and tagSize().

const DtNetUpdateMsg * DtUpdateRoMsg::netUpdateRoMsg ( ) const

protectedvirtual

DtObjectInstanceHandle DtUpdateRoMsg::objHandle ( ) const

virtual

Implements DtUpdateMsg.

References DtNetUpdateMsg::id, and netUpdateRoMsg().

Referenced by printData().

void DtUpdateRoMsg::printData ( DtLogicalTimeFactory * logicalTimeFactory ) const

virtual

Print the data section.

Reimplemented from DtRtiMsg.

References DtUpdateMsg::channel(), DtUpdateMsg::channelIncluded(), classHandle(), DtUpdateMsg::getAttrs(), DtUpdateMsg::numAttrs(), objHandle(), DtUpdateMsg::objName(), DtRtiMsg::orderType(), DtUpdateMsg::tag(), and DtRtiMsg::transportType().

void DtUpdateRoMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtUpdateCb	cb,
		void *	usr
	)

static

References DtUpdateMsg::channelIncluded(), DtDdmUpdateRoMsgKind, DtUpdateRoMsgKind, DtRtiMsg::msgKind(), and DtConnectionMgr::removeMsgCallback().

Referenced by DtObjectMgr::~DtObjectMgr().

DtUpdateRoMsg * DtUpdateRoMsg::selfRo ( ) const

inlineprotectedvirtual

Casts away const-ness.

void DtUpdateRoMsg::set	(	DtObjectInstanceHandle	objHand,
		const char *	objName,
		DtObjectClassHandle	theClass,
		const DtAhvps &	theAttributes,
		char const *	theTag
	)