DtUpdateMsg Class Reference

Inheritance diagram for DtUpdateMsg:

Collaboration diagram for DtUpdateMsg:

Public Member Functions
	DtUpdateMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtUpdateMsg ()
	Destructor.
virtual void	setClassHandle (DtObjectClassHandle hand)=0
	Set/Get handle.
virtual DtObjectClassHandle	classHandle () const =0
virtual void	setObjHandle (DtObjectInstanceHandle id)=0
	Set/Get handle.
virtual DtObjectInstanceHandle	objHandle () const =0
virtual void	setChannel (unsigned long handleValue)
	Set/Get DDM channel.
virtual unsigned long	channel () const
virtual void	setObjName (const char *name, bool resize=true)
	Set/Get name.
virtual const char *	objName () const
virtual void	setTag (char const *tag, bool resize=true)
	Set/Get tag.
virtual char const *	tag () const
virtual void	setAttrs (const DtAhvpBase &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 *	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 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 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 ()

Protected Member Functions
virtual void	setObjNameAndTag (const char *name, char const *tag, bool resize=true)
	sets both the objectName and the tag at the same time, avoiding one resize.
virtual void	setNameSize (int size)=0
	Set/Get name size.
virtual int	nameSize () const =0
virtual void	setTagSize (int size)=0
	Set/Get tag size.
virtual int	tagSize () const =0
virtual DtNetU32 *	channelPtr () const =0
	Returns pointer to the channel in the netMsg.
virtual char *	namePtr ()=0
	Returns pointer to the name in the netMsg.
virtual char *	tagPtr ()=0
	Returns pointer to the tag in the netMsg.
virtual DtNetAttrs *	netAttrs ()=0
	Returns pointer to the network rep of the avList.
virtual DtNetBigAttrs *	netBigAttrs ()=0
	Returns pointer to the network rep of the avList.
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 DtAhvpBase &theAttributes, DtNetAttrs *netRepAttrs)
	Fill the message with the given attributes.
virtual void	fillNetBigAttrs (const DtAhvpBase &attrs, DtNetBigAttrs *netAttrs)
	Fill the message with the given attributes Supports big attribute values > 64K.
virtual void	adjustBufferForAttrs (const DtAhvpBase &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 DtAhvpBase &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 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
int	myAttrHdrAlignment
int	myAttrListHdrSize
int	myAttrHdrSize
unsigned long	myMaxAttrSize
Protected Attributes inherited from DtRtiMsg
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	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 char *	theDefaultTag

Constructor & Destructor Documentation

DtUpdateMsg::DtUpdateMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

virtual DtUpdateMsg::~DtUpdateMsg ( )

virtual

Destructor.

Member Function Documentation

virtual void DtUpdateMsg::adjustBufferForAttrs ( const DtAhvpBase &  attrs )

protectedvirtual

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

virtual int DtUpdateMsg::attrAlignPaddingSize ( unsigned long  offset ) const

protectedvirtual

Returns size of attr list alignment padding.

virtual unsigned long DtUpdateMsg::channel ( ) const

virtual

virtual int DtUpdateMsg::channelFieldSize ( ) const

protectedvirtual

Returns size of serial number field.

bool DtUpdateMsg::channelIncluded ( )

inlinestatic

References theChannelIncluded.

virtual DtNetU32* DtUpdateMsg::channelPtr ( ) const

protectedpure virtual

Returns pointer to the channel in the netMsg.

Implemented in DtUpdateRoMsg.

virtual DtObjectClassHandle DtUpdateMsg::classHandle ( ) const

pure virtual

Implemented in DtUpdateRoMsg.

virtual void DtUpdateMsg::fillFromNetAttrs ( const DtNetAttrs *  netRepAttrs, DtAhvps &  attrs, bool  useMsgMemory, DtObjectClassInfo *  objDesc = NULL, DtHandle  regionSetHandle = DtDefaultRegionSetHandle, DtRtiObject *  obj = NULL, float  tolerance = 0.0  ) const

protectedvirtual

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 DtUpdateMsg::fillFromNetBigAttrs ( const DtNetBigAttrs *  netAttrs, DtAhvps &  attrs, bool  useMsgMemory, DtObjectClassInfo *  objDesc = NULL, DtHandle  regionSetHandle = DtDefaultRegionSetHandle, DtRtiObject *  obj = NULL, float  tolerance = 0.0  ) const

protectedvirtual

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 DtUpdateMsg::fillNetAttrs ( const DtAhvpBase &  theAttributes, DtNetAttrs *  netRepAttrs  )

protectedvirtual

Fill the message with the given attributes.

virtual void DtUpdateMsg::fillNetBigAttrs ( const DtAhvpBase &  attrs, DtNetBigAttrs *  netAttrs  )

protectedvirtual

Fill the message with the given attributes Supports big attribute values > 64K.

virtual void DtUpdateMsg::getAttrs ( DtAhvps &  attrSetBuff, bool  useMsgMemory, DtObjectClassInfo *  objDesc = NULL, DtHandle  regionSetHandle = DtDefaultRegionSetHandle, DtRtiObject *  obj = NULL, float  tolerance = 0.0  ) const

virtual

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 int DtUpdateMsg::nameFieldSize ( ) const

protectedvirtual

Returns size of name field.

virtual char* DtUpdateMsg::namePtr ( )

protectedpure virtual

Returns pointer to the name in the netMsg.

Implemented in DtUpdateRoMsg.

virtual int DtUpdateMsg::nameSize ( ) const

protectedpure virtual

Implemented in DtUpdateRoMsg.

virtual DtNetAttrs* DtUpdateMsg::netAttrs ( )

protectedpure virtual

Returns pointer to the network rep of the avList.

Implemented in DtUpdateRoMsg.

virtual DtNetBigAttrs* DtUpdateMsg::netBigAttrs ( )

protectedpure virtual

Returns pointer to the network rep of the avList.

Supports big attribute values > 64K

Implemented in DtUpdateRoMsg.

virtual DtNetAttrValue* DtUpdateMsg::nextNetAttr ( char *  netAttrTail ) const

protectedvirtual

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

virtual DtNetBigAttrValue* DtUpdateMsg::nextNetBigAttr ( char *  netAttrTail ) const

protectedvirtual

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

Supports big attribute values > 64K

virtual unsigned long DtUpdateMsg::numAttrs ( ) const

virtual

Get number of parameters.

virtual DtObjectInstanceHandle DtUpdateMsg::objHandle ( ) const

pure virtual

Implemented in DtUpdateRoMsg.

virtual const char* DtUpdateMsg::objName ( ) const

virtual

DtUpdateMsg * DtUpdateMsg::self ( ) const

inlineprotectedvirtual

Casts away const-ness.

virtual void DtUpdateMsg::setAttrs ( const DtAhvpBase &  theAttributes, bool  checkBufferSize = true  )

virtual

Set attributes.

virtual void DtUpdateMsg::setChannel ( unsigned long  handleValue )

virtual

Set/Get DDM channel.

static void DtUpdateMsg::setChannelIncluded ( bool  includeChannel )

static

Set/Get flag to include DDM channel identifier.

virtual void DtUpdateMsg::setClassHandle ( DtObjectClassHandle  hand )

pure virtual

Set/Get handle.

Implemented in DtUpdateRoMsg.

virtual void DtUpdateMsg::setNameSize ( int  size )

protectedpure virtual

Set/Get name size.

Implemented in DtUpdateRoMsg.

virtual void DtUpdateMsg::setObjHandle ( DtObjectInstanceHandle  id )

pure virtual

Set/Get handle.

Implemented in DtUpdateRoMsg.

virtual void DtUpdateMsg::setObjName ( const char *  name, bool  resize = true  )

virtual

Set/Get name.

virtual void DtUpdateMsg::setObjNameAndTag ( const char *  name, char const *  tag, bool  resize = true  )

protectedvirtual

sets both the objectName and the tag at the same time, avoiding one resize.

virtual void DtUpdateMsg::setTag ( char const *  tag, bool  resize = true  )

virtual

Set/Get tag.

virtual void DtUpdateMsg::setTagSize ( int  size )

protectedpure virtual

Set/Get tag size.

Implemented in DtUpdateRoMsg.

virtual unsigned long DtUpdateMsg::sizeNeededForNetAttr ( unsigned long  attrOffset, unsigned long  attrSize  ) const

protectedvirtual

Returns the size the network representation will consume.

virtual unsigned long DtUpdateMsg::sizeNeededForNetAttrs ( unsigned long  offset, const DtAhvpBase &  attrs  ) const

protectedvirtual

Returns the size the network representation will consume.

virtual char const* DtUpdateMsg::tag ( ) const

virtual

virtual int DtUpdateMsg::tagFieldSize ( ) const

protectedvirtual

Returns size of tag field.

virtual char* DtUpdateMsg::tagPtr ( )

protectedpure virtual

Returns pointer to the tag in the netMsg.

Implemented in DtUpdateRoMsg.

virtual int DtUpdateMsg::tagSize ( ) const

protectedpure virtual

Implemented in DtUpdateRoMsg.

Member Data Documentation

int DtUpdateMsg::myAttrHdrAlignment

protected

int DtUpdateMsg::myAttrHdrSize

protected

int DtUpdateMsg::myAttrListHdrSize

protected

unsigned long DtUpdateMsg::myMaxAttrSize

protected

bool DtUpdateMsg::theChannelIncluded

staticprotected

Referenced by channelIncluded().

---

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

• updateMsg.h