DtUpdateRoMsg Class Reference

Inheritance diagram for DtUpdateRoMsg:

Collaboration diagram for DtUpdateRoMsg:

Public Member Functions
	DtUpdateRoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor. More...
	DtUpdateRoMsg (DtObjectInstanceHandle objHand, const char *objName, DtObjectClassHandle classHand, const DtAhvpBase &theAttributes, DtRtiApiTagConstRef theTag, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtUpdateRoMsg (const DtNetUpdateMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtUpdateRoMsg ()
	Destructor. More...
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this. More...
virtual void	set (DtObjectInstanceHandle objHand, const char *objName, DtObjectClassHandle theClass, const DtAhvpBase &theAttributes, DtRtiApiTagConstRef theTag, bool adjustBufferSize=true)
	Set all fields simultaneously (adjust buffer size if not pre-allocated for this data) More...
virtual void	setClassHandle (DtObjectClassHandle hand)
	Set/Get handle. More...
virtual DtObjectClassHandle	classHandle () const
virtual void	setObjHandle (DtObjectInstanceHandle id)
	Set/Get handle. More...
virtual DtObjectInstanceHandle	objHandle () const
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print the data section. More...
Public Member Functions inherited from DtUpdateMsg
	DtUpdateMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor. More...
virtual	~DtUpdateMsg ()
	Destructor. More...
virtual void	setChannel (unsigned long handleValue)
	Set/Get DDM channel. More...
virtual unsigned long	channel () const
virtual const char *	objName () const
	Get name. More...
virtual DtRtiApiTagConstRef	tag () const
	Get tag. More...
virtual void	setAttrs (const DtAhvpBase &theAttributes, bool adjustBufferSize=true)
	Set attributes (adjust buffer size if not pre-allocated for this data) More...
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. More...
virtual unsigned long	numAttrs () const
	Get number of parameters. More...
Public Member Functions inherited from DtRtiMsg
virtual	~DtRtiMsg ()
	Destructor. 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	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 DtRtiMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creator. More...
static DtRtiMsg *	create (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtConnectionMgr *conn, DtUpdateCb cb, void *usr)
	Callback management. More...
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. 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 DtNetUpdateMsg *	netUpdateRoMsg ()
	The network representation. More...
virtual const DtNetUpdateMsg *	netUpdateRoMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Update Msg. More...
virtual int	minSize (const DtAhvpBase *attrs=NULL, const char *objName=NULL, DtRtiApiTagConstRef theTag=theDefaultTag) const
	Returns minimum size of a message, including header. More...
virtual void	setNameSize (int size)
	Set/Get name size. More...
virtual int	nameSize () const
virtual void	setTagSize (int size)
	Set/Get tag size. More...
virtual int	tagSize () const
virtual int	attributeFieldSize () const
	Returns the current size of the attribute field. More...
virtual DtNetAttrs *	netAttrs ()
	Returns pointer to the network rep of the pvList. More...
virtual DtNetBigAttrs *	netBigAttrs ()
	Returns pointer to the network rep of the avList. More...
virtual DtNetU32 *	channelPtr () const
	Returns pointer to the channel in the netMsg. More...
virtual char *	namePtr ()
	Returns pointer to the name in the netMsg. More...
virtual char *	tagPtr ()
	Returns pointer to the tag in the netMsg. More...
virtual DtUpdateRoMsg *	selfRo () const
	Casts away const-ness. More...
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. More...
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. More...
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. More...
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. More...
virtual void	fillNetAttrs (const DtAhvpBase &theAttributes, DtNetAttrs *netRepAttrs)
	Fill the message with the given attributes. More...
virtual void	fillNetBigAttrs (const DtAhvpBase &attrs, DtNetBigAttrs *netAttrs)
	Fill the message with the given attributes Supports big attribute values > 64K. More...
virtual void	adjustBufferForAttrs (const DtAhvpBase &attrs)
	Adjust size/bytes for the network rep of the avList. More...
virtual unsigned long	sizeNeededForNetAttr (unsigned long attrOffset, unsigned long attrSize) const
	Returns the size the network representation will consume. More...
virtual unsigned long	sizeNeededForNetAttrs (unsigned long offset, const DtAhvpBase &attrs) const
	Returns the size the network representation will consume. More...
virtual int	channelFieldSize () const
	Returns size of channel field. More...
virtual int	attrAlignPaddingSize (unsigned long offset) const
	Returns size of attr list alignment padding. More...
virtual DtUpdateMsg *	self () const
	Casts away const-ness. More...
virtual void	setObjName (const char *name, bool adjustBufferSize=true)
	The individual set value methods for variable data moved to protected because changing these after attributes have been set can break byte alignment. More...
virtual void	setTag (DtRtiApiTagConstRef tag, bool adjustBufferSize=true)
	Set tag. More...
Protected Member Functions inherited from DtRtiMsg
	DtRtiMsg ()
	Constructor. More...
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...

Additional Inherited Members
Static Public Attributes inherited from DtRtiMsg
static unsigned long	theDefaultRegionSetHandle
static const DtRtiApiVariableLengthData	theDefaultTag
Protected Attributes inherited from DtUpdateMsg
DtRtiApiTagPtr	myTag
int	myAttrHdrAlignment
int	myAttrListHdrSize
int	myAttrHdrSize
unsigned long	myMaxAttrSize
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 inherited from DtUpdateMsg
static bool	theChannelIncluded
Static Protected Attributes inherited from DtRtiMsg
static bool	theUse32BitsForValueSize
static bool	theSmartForwardingEnabled

Constructor & Destructor Documentation

DtUpdateRoMsg::DtUpdateRoMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

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

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

virtual DtUpdateRoMsg::~DtUpdateRoMsg ( )

virtual

Destructor.

Member Function Documentation

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

static

Callback management.

virtual int DtUpdateRoMsg::attributeFieldSize ( ) const

protectedvirtual

Returns the current size of the attribute field.

Implements DtUpdateMsg.

virtual DtNetU32* DtUpdateRoMsg::channelPtr ( ) const

protectedvirtual

Returns pointer to the channel in the netMsg.

Implements DtUpdateMsg.

virtual DtObjectClassHandle DtUpdateRoMsg::classHandle ( ) const

virtual

Implements DtUpdateMsg.

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

virtual

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

Implements DtRtiMsg.

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

static

Creator.

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

static

virtual DtRtiMsgKind DtUpdateRoMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an Update Msg.

Implements DtRtiMsg.

virtual int DtUpdateRoMsg::minSize ( const DtAhvpBase *  attrs = NULL, const char *  objName = NULL, DtRtiApiTagConstRef  theTag = theDefaultTag  ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual char* DtUpdateRoMsg::namePtr ( )

protectedvirtual

Returns pointer to the name in the netMsg.

Implements DtUpdateMsg.

virtual int DtUpdateRoMsg::nameSize ( ) const

protectedvirtual

Implements DtUpdateMsg.

virtual DtNetAttrs* DtUpdateRoMsg::netAttrs ( )

protectedvirtual

Returns pointer to the network rep of the pvList.

Implements DtUpdateMsg.

virtual DtNetBigAttrs* DtUpdateRoMsg::netBigAttrs ( )

protectedvirtual

Returns pointer to the network rep of the avList.

Supports big attribute values > 64K

Implements DtUpdateMsg.

virtual DtNetUpdateMsg* DtUpdateRoMsg::netUpdateRoMsg ( )

protectedvirtual

The network representation.

virtual const DtNetUpdateMsg* DtUpdateRoMsg::netUpdateRoMsg ( ) const

protectedvirtual

virtual DtObjectInstanceHandle DtUpdateRoMsg::objHandle ( ) const

virtual

Implements DtUpdateMsg.

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

virtual

Print the data section.

Reimplemented from DtRtiMsg.

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

static

DtUpdateRoMsg * DtUpdateRoMsg::selfRo ( ) const

inlineprotectedvirtual

Casts away const-ness.

virtual void DtUpdateRoMsg::set ( DtObjectInstanceHandle  objHand, const char *  objName, DtObjectClassHandle  theClass, const DtAhvpBase &  theAttributes, DtRtiApiTagConstRef  theTag, bool  adjustBufferSize = true  )

virtual

Set all fields simultaneously (adjust buffer size if not pre-allocated for this data)

virtual void DtUpdateRoMsg::setClassHandle ( DtObjectClassHandle  hand )

virtual

Set/Get handle.

Implements DtUpdateMsg.

virtual void DtUpdateRoMsg::setNameSize ( int  size )

protectedvirtual

Set/Get name size.

Implements DtUpdateMsg.

virtual void DtUpdateRoMsg::setObjHandle ( DtObjectInstanceHandle  id )

virtual

Set/Get handle.

Implements DtUpdateMsg.

virtual void DtUpdateRoMsg::setTagSize ( int  size )

protectedvirtual

Set/Get tag size.

Implements DtUpdateMsg.

virtual char* DtUpdateRoMsg::tagPtr ( )

protectedvirtual

Returns pointer to the tag in the netMsg.

Implements DtUpdateMsg.

virtual int DtUpdateRoMsg::tagSize ( ) const

protectedvirtual

Implements DtUpdateMsg.

---

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

• updateRoMsg.h