DtOwnershipMsg Class Reference

Inheritance diagram for DtOwnershipMsg:

Collaboration diagram for DtOwnershipMsg:

List of all members.

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.
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)
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 Attributes
int	myDirty
DtAttributeHandleSet *	myAttrs
char *	myTag

---

Constructor & Destructor Documentation

DtOwnershipMsg::DtOwnershipMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

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

Referenced by clone(), and create().

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

Constructor.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), setAttrHandles(), setObjHandle(), setOwnerMsgKind(), setRecipientFederate(), and setTag().

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.

References DtAttributeHandleSet::add(), DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), setAttrHandles(), setObjHandle(), setOwnerMsgKind(), setRecipientFederate(), and setTag().

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

Constructor.

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

DtOwnershipMsg::~DtOwnershipMsg

(

)

[virtual]

Destructor.

References myAttrs.

---

Member Function Documentation

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

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtOwnershipMsgKind.

Referenced by DtFedExec::DtFedExec(), and DtObjectMgr::DtObjectMgr().

const DtAttributeHandleSet & DtOwnershipMsg::attrHandles

(

)

const [virtual]

References DtAttributeHandleSet::decode(), DtNetOwnershipMsg::handleSet, myAttrs, myDirty, and netOwnershipMsg().

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

DtObjectClassHandle DtOwnershipMsg::classHandle

(

)

const [virtual]

References DtNetOwnershipMsg::handle, and netOwnershipMsg().

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

DtRtiMsg * DtOwnershipMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtOwnershipMsg(), and netOwnershipMsg().

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

Creator.

References DtOwnershipMsg().

DtRtiMsg * DtOwnershipMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

Creator.

References DtOwnershipMsg().

DtRtiMsgKind DtOwnershipMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of an Ownership Msg.

Implements DtRtiMsg.

References DtOwnershipMsgKind.

Referenced by DtOwnershipMsg().

int DtOwnershipMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtOwnershipMsg().

DtNetOwnershipMsg * DtOwnershipMsg::netOwnershipMsg

(

)

[protected, virtual]

The network representation.

Referenced by attrHandles(), classHandle(), clone(), objHandle(), ownerMsgKind(), recipientFederate(), setAttrHandles(), setClassHandle(), setObjHandle(), setOwnerMsgKind(), setRecipientFederate(), setTag(), tag(), tagFieldSize(), and tagPtr().

const DtNetOwnershipMsg * DtOwnershipMsg::netOwnershipMsg

(

)

const [protected, virtual]

DtObjectInstanceHandle DtOwnershipMsg::objHandle

(

)

const [virtual]

References DtNetOwnershipMsg::id, and netOwnershipMsg().

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

DtOwnerMsgKind DtOwnershipMsg::ownerMsgKind

(

)

const [virtual]

References netOwnershipMsg(), and DtNetOwnershipMsg::ownerMsgKind.

Referenced by printData(), DtFedExec::processOwnership(), and DtObjectMgr::processOwnership().

void DtOwnershipMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References attrHandles(), classHandle(), DtAcquire, DtAcquireIfAvail, DtCancelAcquire, DtCancelNegotiatedDivest, DtConfirmCancelAcquire, DtENUMSTR, DtGiveToLRC, DtInformOwner, DtMomTransfer, DtNegotiatedDivest, DtNotifyAcquire, DtNotOwned, DtOwnedByRti, DtOwnershipUnavail, DtQueryAttrTransportType, DtQueryOwner, DtResetOwner, DtUncondDivest, objHandle(), ownerMsgKind(), DtRtiMsg::print(), recipientFederate(), and tag().

DtFederateHandle DtOwnershipMsg::recipientFederate

(

)

const [virtual]

References netOwnershipMsg(), and DtNetOwnershipMsg::recvFed.

Referenced by printData(), DtFedExec::processOwnership(), and DtObjectMgr::processOwnership().

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

References DtOwnershipMsgKind, and DtConnectionMgr::removeMsgCallback().

Referenced by DtFedExec::~DtFedExec(), and DtObjectMgr::~DtObjectMgr().

DtOwnershipMsg * DtOwnershipMsg::self

(

)

const [inline, protected, virtual]

Casts away const-ness.

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

Set all fields simultaneously.

Referenced by DtObjectMgr::releaseAllAttributes(), and DtObjectMgr::sendOwnershipMsg().

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

References DtAttributeHandleSet::add().

void DtOwnershipMsg::setAttrHandles

(

const DtAttributeHandleSet &

attrs

)

[virtual]

Set/Get attribute handles.

References myDirty, and netOwnershipMsg().

Referenced by DtOwnershipMsg().

void DtOwnershipMsg::setClassHandle

(

DtObjectClassHandle

handle

)

[virtual]

Set/Get class handle.

References DtNetOwnershipMsg::handle, and netOwnershipMsg().

Referenced by DtObjectMgr::releaseAllAttributes().

void DtOwnershipMsg::setObjHandle

(

DtObjectInstanceHandle

id

)

[virtual]

Set/Get handle.

References DtNetOwnershipMsg::id, and netOwnershipMsg().

Referenced by DtOwnershipMsg().

void DtOwnershipMsg::setOwnerMsgKind

(

DtOwnerMsgKind

kind

)

[virtual]

Set/Get kind.

References netOwnershipMsg(), and DtNetOwnershipMsg::ownerMsgKind.

Referenced by DtOwnershipMsg().

void DtOwnershipMsg::setRecipientFederate

(

DtFederateHandle

hand

)

[virtual]

Set/Get recipient federate handle.

References netOwnershipMsg(), and DtNetOwnershipMsg::recvFed.

Referenced by DtOwnershipMsg(), and DtFedExec::processOwnership().

void DtOwnershipMsg::setTag

(

char const *

tag

)

[virtual]

Set/Get tag.

References rti1516e::insertBytes(), myTag, netOwnershipMsg(), NULL, tagFieldSize(), tagPtr(), and DtNetOwnershipMsg::tagSize.

Referenced by DtOwnershipMsg().

char const * DtOwnershipMsg::tag

(

)

const [virtual]

References myTag, netOwnershipMsg(), NULL, tagPtr(), and DtNetOwnershipMsg::tagSize.

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

int DtOwnershipMsg::tagFieldSize

(

)

const [protected, virtual]

Returns size of tag field.

References netOwnershipMsg(), and DtNetOwnershipMsg::tagSize.

Referenced by setTag().

char * DtOwnershipMsg::tagPtr

(

)

[protected, virtual]

Returns pointer to the tag in the netMsg.

References netOwnershipMsg().

Referenced by setTag(), and tag().

---

Member Data Documentation

DtAttributeHandleSet* DtOwnershipMsg::myAttrs [protected]

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

int DtOwnershipMsg::myDirty [protected]

Referenced by attrHandles(), and setAttrHandles().

char* DtOwnershipMsg::myTag [protected]

Referenced by setTag(), and tag().

---

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

• ownerMsg.h
• ownerMsg.cxx