DtSubObjMsg Class Reference

Inheritance diagram for DtSubObjMsg:

Collaboration diagram for DtSubObjMsg:

Public Member Functions
	DtSubObjMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtSubObjMsg (DtObjectClassHandle theObj, bool isPassiveValue, bool replacementValue, const DtAttributeHandleSet &theSet, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtSubObjMsg (const DtNetSubObjMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtSubObjMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (DtObjectClassHandle theObj, bool isPassiveValue, bool replacementValue, const DtAttributeHandleSet &theSet)
	Set all fields simultaneously.
virtual void	setObjectClassHandle (DtObjectClassHandle hand)
	Set/Get handle.
virtual DtObjectClassHandle	objectClassHandle () const
virtual void	setIsPassive (bool isPassiveValue)
	Set/Get isPassive.
virtual bool	isPassive () const
virtual void	setReplacement (bool replacementValue)
	Set/Get replacement (if false passive subscription will not replace any existing active subscription)
virtual bool	replacement () const
virtual void	setAttrHandles (const DtAttributeHandleSet &attrs)
	Set/Get attribute handles.
virtual const DtAttributeHandleSet &	attrHandles () const
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print the data section.
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 (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creator.
static DtRtiMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creator.
static void	addCallback (DtConnectionMgr *conn, DtSubObjCb cb, void *usr, bool isMomCallback=false)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtSubObjCb cb, void *usr, bool isMomCallback=false)
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 DtNetSubObjMsg *	netSubObjMsg ()
	The network representation.
virtual const DtNetSubObjMsg *	netSubObjMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an SubObj Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual DtSubObjMsg *	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.

Protected Attributes
int	myDirty
DtAttributeHandleSet *	myAttrs
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

Additional Inherited Members
Static Public Attributes inherited from DtRtiMsg
static unsigned long	theDefaultRegionSetHandle = 0
static const char *	theDefaultTag = NULL
Static Protected Attributes inherited from DtRtiMsg
static bool	theUse32BitsForValueSize = false
static bool	theSmartForwardingEnabled = false

Constructor & Destructor Documentation

DtSubObjMsg::DtSubObjMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

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

Referenced by clone(), and create().

DtSubObjMsg::DtSubObjMsg	(	DtObjectClassHandle	theObj,
		bool	isPassiveValue,
		bool	replacementValue,
		const DtAttributeHandleSet &	theSet,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), setAttrHandles(), setIsPassive(), setObjectClassHandle(), and setReplacement().

DtSubObjMsg::DtSubObjMsg	(	const DtNetSubObjMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

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

DtSubObjMsg::~DtSubObjMsg ( )

virtual

Destructor.

References myAttrs.

Member Function Documentation

void DtSubObjMsg::addCallback ( DtConnectionMgr *  conn, DtSubObjCb  cb, void *  usr, bool  isMomCallback = false  )

static

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtSubObjMsgKind.

Referenced by DtObjectMgr::DtObjectMgr().

const DtAttributeHandleSet & DtSubObjMsg::attrHandles ( ) const

virtual

References DtAttributeHandleSet::decode(), DtNetSubObjMsg::handleSet, myAttrs, myDirty, and netSubObjMsg().

Referenced by printData(), and DtObjectMgr::processSub().

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

virtual

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

Implements DtRtiMsg.

References DtSubObjMsg(), and netSubObjMsg().

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

static

Creator.

References DtSubObjMsg().

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

static

Creator.

References DtSubObjMsg().

DtRtiMsgKind DtSubObjMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an SubObj Msg.

Implements DtRtiMsg.

References DtSubObjMsgKind.

Referenced by DtSubObjMsg().

bool DtSubObjMsg::isPassive ( ) const

virtual

References DtNetSubObjMsg::isPassive, and netSubObjMsg().

Referenced by printData(), and DtObjectMgr::processSub().

int DtSubObjMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtSubObjMsg().

DtNetSubObjMsg * DtSubObjMsg::netSubObjMsg ( )

protectedvirtual

The network representation.

Referenced by attrHandles(), clone(), isPassive(), objectClassHandle(), replacement(), setAttrHandles(), setIsPassive(), setObjectClassHandle(), and setReplacement().

const DtNetSubObjMsg * DtSubObjMsg::netSubObjMsg ( ) const

protectedvirtual

DtObjectClassHandle DtSubObjMsg::objectClassHandle ( ) const

virtual

References DtNetSubObjMsg::handle, and netSubObjMsg().

Referenced by printData(), and DtObjectMgr::processSub().

void DtSubObjMsg::printData ( DtLogicalTimeFactory *  logicalTimeFactory ) const

virtual

Print the data section.

Reimplemented from DtRtiMsg.

References attrHandles(), isPassive(), objectClassHandle(), DtRtiMsg::print(), and replacement().

void DtSubObjMsg::removeCallback ( DtConnectionMgr *  conn, DtSubObjCb  cb, void *  usr, bool  isMomCallback = false  )

static

References DtSubObjMsgKind, and DtConnectionMgr::removeMsgCallback().

Referenced by DtObjectMgr::~DtObjectMgr().

bool DtSubObjMsg::replacement ( ) const

virtual

References netSubObjMsg(), and DtNetSubObjMsg::replacement.

Referenced by printData(), and DtObjectMgr::processSub().

DtSubObjMsg * DtSubObjMsg::self ( ) const

inlineprotectedvirtual

Casts away const-ness.

void DtSubObjMsg::set ( DtObjectClassHandle  theObj, bool  isPassiveValue, bool  replacementValue, const DtAttributeHandleSet &  theSet  )

virtual

Set all fields simultaneously.

References setAttrHandles(), setIsPassive(), setObjectClassHandle(), and setReplacement().

Referenced by DtObjectMgr::sendSubscribeMsg().

void DtSubObjMsg::setAttrHandles ( const DtAttributeHandleSet &  attrs )

virtual

Set/Get attribute handles.

References myDirty, and netSubObjMsg().

Referenced by DtSubObjMsg(), and set().

void DtSubObjMsg::setIsPassive ( bool  isPassiveValue )

virtual

Set/Get isPassive.

References DtNetSubObjMsg::isPassive, and netSubObjMsg().

Referenced by DtSubObjMsg(), and set().

void DtSubObjMsg::setObjectClassHandle ( DtObjectClassHandle  hand )

virtual

Set/Get handle.

References DtNetSubObjMsg::handle, and netSubObjMsg().

Referenced by DtSubObjMsg(), and set().

void DtSubObjMsg::setReplacement ( bool  replacementValue )

virtual

Set/Get replacement (if false passive subscription will not replace any existing active subscription)

References netSubObjMsg(), and DtNetSubObjMsg::replacement.

Referenced by DtSubObjMsg(), and set().

Member Data Documentation

DtAttributeHandleSet* DtSubObjMsg::myAttrs

protected

Referenced by attrHandles(), and ~DtSubObjMsg().

int DtSubObjMsg::myDirty

protected

Referenced by attrHandles(), and setAttrHandles().

---

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

• subObjMsg.h
• subObjMsg.cxx