DtOwnershipMsg Class Reference

Inheritance diagram for DtOwnershipMsg:

Collaboration diagram for DtOwnershipMsg:

Public Member Functions
	DtOwnershipMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtOwnershipMsg (DtOwnerMsgKind kind, DtObjectInstanceHandle objHand, const DtAttributeHandleSet &attrs, DtFederateHandle targetFed=0, char const *theTag=NULL, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtOwnershipMsg (DtOwnerMsgKind kind, DtObjectInstanceHandle objHand, const DtAttributeHandle attr, DtFederateHandle targetFed=0, char const *theTag=NULL, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor, with single attribute handle.
	DtOwnershipMsg (const DtNetOwnershipMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtOwnershipMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (DtOwnerMsgKind kind, DtObjectInstanceHandle objHand, const DtAttributeHandleSet &attrs, DtFederateHandle targetFed=0, char const *theTag=theDefaultTag)
	Set all fields simultaneously.
virtual void	set (DtOwnerMsgKind kind, DtObjectInstanceHandle objHand, const DtAttributeHandle attr, DtFederateHandle targetFed=0, char const *theTag=theDefaultTag)
virtual void	setOwnerMsgKind (DtOwnerMsgKind kind)
	Set/Get kind.
virtual DtOwnerMsgKind	ownerMsgKind () const
virtual void	setObjHandle (DtObjectInstanceHandle id)
	Set/Get handle.
virtual DtObjectInstanceHandle	objHandle () const
virtual void	setClassHandle (DtObjectClassHandle handle)
	Set/Get class handle.
virtual DtObjectClassHandle	classHandle () const
virtual void	setTag (char const *tag)
	Set/Get tag.
virtual char const *	tag () const
virtual void	setRecipientFederate (DtFederateHandle hand)
	Set/Get recipient federate handle.
virtual DtFederateHandle	recipientFederate () 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, DtOwnershipCb cb, void *usr)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtOwnershipCb cb, void *usr)
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 char *	tagPtr ()
	Returns pointer to the tag in the netMsg.
virtual int	tagFieldSize () const
	Returns size of tag field.
virtual DtNetOwnershipMsg *	netOwnershipMsg ()
	The network representation.
virtual const DtNetOwnershipMsg *	netOwnershipMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Ownership Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual DtOwnershipMsg *	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
char *	myTag
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
static const char *	theDefaultTag
Static Protected Attributes inherited from DtRtiMsg
static bool	theUse32BitsForValueSize
static bool	theSmartForwardingEnabled

Constructor & Destructor Documentation

DtOwnershipMsg::DtOwnershipMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

DtOwnershipMsg::DtOwnershipMsg	(	DtOwnerMsgKind	kind,
		DtObjectInstanceHandle	objHand,
		const DtAttributeHandleSet &	attrs,
		DtFederateHandle	targetFed = 0,
		char const *	theTag = NULL,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

DtOwnershipMsg::DtOwnershipMsg	(	DtOwnerMsgKind	kind,
		DtObjectInstanceHandle	objHand,
		const DtAttributeHandle	attr,
		DtFederateHandle	targetFed = 0,
		char const *	theTag = NULL,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor, with single attribute handle.

DtOwnershipMsg::DtOwnershipMsg	(	const DtNetOwnershipMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

virtual DtOwnershipMsg::~DtOwnershipMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtOwnershipMsg::addCallback ( DtConnectionMgr *  conn, DtOwnershipCb  cb, void *  usr  )

static

Callback management.

virtual const DtAttributeHandleSet& DtOwnershipMsg::attrHandles ( ) const

virtual

virtual DtObjectClassHandle DtOwnershipMsg::classHandle ( ) const

virtual

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

virtual

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

Implements DtRtiMsg.

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

static

Creator.

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

static

Creator.

virtual DtRtiMsgKind DtOwnershipMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an Ownership Msg.

Implements DtRtiMsg.

virtual int DtOwnershipMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetOwnershipMsg* DtOwnershipMsg::netOwnershipMsg ( )

protectedvirtual

The network representation.

virtual const DtNetOwnershipMsg* DtOwnershipMsg::netOwnershipMsg ( ) const

protectedvirtual

virtual DtObjectInstanceHandle DtOwnershipMsg::objHandle ( ) const

virtual

virtual DtOwnerMsgKind DtOwnershipMsg::ownerMsgKind ( ) const

virtual

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

virtual

Print the data section.

Reimplemented from DtRtiMsg.

virtual DtFederateHandle DtOwnershipMsg::recipientFederate ( ) const

virtual

static void DtOwnershipMsg::removeCallback ( DtConnectionMgr *  conn, DtOwnershipCb  cb, void *  usr  )

static

DtOwnershipMsg * DtOwnershipMsg::self ( ) const

inlineprotectedvirtual

Casts away const-ness.

virtual void DtOwnershipMsg::set ( DtOwnerMsgKind  kind, DtObjectInstanceHandle  objHand, const DtAttributeHandleSet &  attrs, DtFederateHandle  targetFed = 0, char const *  theTag = theDefaultTag  )

virtual

Set all fields simultaneously.

virtual void DtOwnershipMsg::set ( DtOwnerMsgKind  kind, DtObjectInstanceHandle  objHand, const DtAttributeHandle  attr, DtFederateHandle  targetFed = 0, char const *  theTag = theDefaultTag  )

virtual

virtual void DtOwnershipMsg::setAttrHandles ( const DtAttributeHandleSet &  attrs )

virtual

Set/Get attribute handles.

virtual void DtOwnershipMsg::setClassHandle ( DtObjectClassHandle  handle )

virtual

Set/Get class handle.

virtual void DtOwnershipMsg::setObjHandle ( DtObjectInstanceHandle  id )

virtual

Set/Get handle.

virtual void DtOwnershipMsg::setOwnerMsgKind ( DtOwnerMsgKind  kind )

virtual

Set/Get kind.

virtual void DtOwnershipMsg::setRecipientFederate ( DtFederateHandle  hand )

virtual

Set/Get recipient federate handle.

virtual void DtOwnershipMsg::setTag ( char const *  tag )

virtual

Set/Get tag.

virtual char const* DtOwnershipMsg::tag ( ) const

virtual

virtual int DtOwnershipMsg::tagFieldSize ( ) const

protectedvirtual

Returns size of tag field.

virtual char* DtOwnershipMsg::tagPtr ( )

protectedvirtual

Returns pointer to the tag in the netMsg.

Member Data Documentation

DtAttributeHandleSet* DtOwnershipMsg::myAttrs

protected

int DtOwnershipMsg::myDirty

protected

char* DtOwnershipMsg::myTag

protected

---

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

• ownerMsg.h