DtResignMsg Class Reference

Inheritance diagram for DtResignMsg:

Collaboration diagram for DtResignMsg:

List of all members.

Public Member Functions
	DtResignMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtResignMsg (const char *fedExName, DtFederateHandle fedHandle, DtResignAction action, DtResignReason reason, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtResignMsg (const DtNetResignMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtResignMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (const char *fedExName, DtFederateHandle fedHandle, DtResignAction action, DtResignReason reason)
	Set all fields simultaneously.
virtual void	setResignAction (DtResignAction action)
	Set/Get resign action.
virtual DtResignAction	resignAction () const
virtual void	setResignReason (DtResignReason reason)
	Get/Set resign reason.
virtual DtResignReason	resignReason () const
virtual void	setTimeStamp (RTI::FedTime const &time)
	Get/Set last known time stamp.
virtual RTI::FedTime const *	timeStamp (DtLogicalTimeFactory *logicalTimeFactory) const
virtual void	setTimeStampSize (int size)
	Set/Get time stamp size.
virtual int	timeStampSize () 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, DtResignCb cb, void *usr, bool isMomCallback=false)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtResignCb cb, void *usr, bool isMomCallback=false)
Protected Member Functions
virtual DtNetResignMsg *	netResignMsg ()
	The network representation.
virtual const DtNetResignMsg *	netResignMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Resign Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual int	timeStampFieldSize () const
	Returns size of time stamp field (including serial number)
virtual char *	timeStampPtr ()
	Returns pointer to the time stamp in the netMsg.
virtual DtResignMsg *	self () const
	Casts away const-ness.
Protected Attributes
RTI::FedTime *	myTimeStamp
	use base rti message time

---

Constructor & Destructor Documentation

DtResignMsg::DtResignMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

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

Referenced by clone(), and create().

DtResignMsg::DtResignMsg	(	const char *	fedExName,
		DtFederateHandle	fedHandle,
		DtResignAction	action,
		DtResignReason	reason,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), DtRtiMsg::myAllowedDuringSave, DtRtiMsg::setFederateHandle(), DtRtiMsg::setFedEx(), setResignAction(), and setResignReason().

DtResignMsg::DtResignMsg	(	const DtNetResignMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

References DtNetResignMsg::header, DtRtiMsg::initDtRtiMsg(), and DtRtiMsg::myAllowedDuringSave.

DtResignMsg::~DtResignMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtResignMsg::addCallback	(	DtConnectionMgr *	conn,
		DtResignCb	cb,
		void *	usr,
		bool	isMomCallback = false
	)		[static]

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtResignMsgKind.

Referenced by DtFedExec::DtFedExec(), and DtFederateMgr::postJoinInit().

DtRtiMsg * DtResignMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtResignMsg(), and netResignMsg().

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

Creator.

References DtResignMsg().

DtRtiMsg * DtResignMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

Creator.

References DtResignMsg().

DtRtiMsgKind DtResignMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of an Resign Msg.

Implements DtRtiMsg.

References DtResignMsgKind.

Referenced by DtResignMsg().

int DtResignMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtResignMsg().

DtNetResignMsg * DtResignMsg::netResignMsg

(

)

[protected, virtual]

The network representation.

Referenced by clone(), resignAction(), resignReason(), setResignAction(), setResignReason(), setTimeStampSize(), timeStampFieldSize(), timeStampPtr(), and timeStampSize().

const DtNetResignMsg * DtResignMsg::netResignMsg

(

)

const [protected, virtual]

void DtResignMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References DtENUMSTR, and resignAction().

void DtResignMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtResignCb	cb,
		void *	usr,
		bool	isMomCallback = false
	)		[static]

References DtResignMsgKind, and DtConnectionMgr::removeMsgCallback().

Referenced by DtFederateMgr::resignFederationExecution(), DtFederateMgr::~DtFederateMgr(), and DtFedExec::~DtFedExec().

DtResignAction DtResignMsg::resignAction

(

)

const [virtual]

References netResignMsg(), and DtNetResignMsg::resignAction.

Referenced by printData(), DtFederateMgr::processResign(), and DtObjectMgr::processResign().

DtResignReason DtResignMsg::resignReason

(

)

const [virtual]

References netResignMsg(), and DtNetResignMsg::resignReason.

DtResignMsg * DtResignMsg::self

(

)

const [inline, protected, virtual]

Casts away const-ness.

void DtResignMsg::set	(	const char *	fedExName,
		DtFederateHandle	fedHandle,
		DtResignAction	action,
		DtResignReason	reason
	)		[virtual]

Set all fields simultaneously.

References DtRtiMsg::setFederateHandle(), DtRtiMsg::setFedEx(), setResignAction(), and setResignReason().

Referenced by DtFedExec::sendResignMsg(), and DtFederateMgr::sendResignMsg().

void DtResignMsg::setResignAction

(

DtResignAction

action

)

[virtual]

Set/Get resign action.

References netResignMsg(), and DtNetResignMsg::resignAction.

Referenced by DtResignMsg(), and set().

void DtResignMsg::setResignReason

(

DtResignReason

reason

)

[virtual]

Get/Set resign reason.

References netResignMsg(), and DtNetResignMsg::resignReason.

Referenced by DtResignMsg(), and set().

void DtResignMsg::setTimeStamp

(

RTI::FedTime const &

time

)

[virtual]

Get/Set last known time stamp.

References RTI::FedTime::encode(), and RTI::FedTime::encodedLength().

Referenced by DtFedExec::sendResignMsg().

void DtResignMsg::setTimeStampSize

(

int

size

)

[virtual]

Set/Get time stamp size.

References netResignMsg(), and DtNetResignMsg::timeStampSize.

RTI::FedTime const * DtResignMsg::timeStamp

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

References DtLogicalTimeFactory::decode(), myTimeStamp, NULL, and timeStampPtr().

int DtResignMsg::timeStampFieldSize

(

)

const [protected, virtual]

Returns size of time stamp field (including serial number)

References netResignMsg(), and timeStampSize().

char * DtResignMsg::timeStampPtr

(

)

[protected, virtual]

Returns pointer to the time stamp in the netMsg.

References netResignMsg().

Referenced by timeStamp().

int DtResignMsg::timeStampSize

(

)

const [virtual]

References netResignMsg(), and DtNetResignMsg::timeStampSize.

Referenced by timeStampFieldSize().

---

Member Data Documentation

RTI::FedTime* DtResignMsg::myTimeStamp [protected]

use base rti message time

Referenced by timeStamp().

---

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

• resignMsg.h
• resignMsg.cxx