DtSmEnrollmentMsg Class Reference

IMPORTANT NOTE: Multicast Configuration message are not intended for dissemination over the network. More...

Inheritance diagram for DtSmEnrollmentMsg:

Collaboration diagram for DtSmEnrollmentMsg:

List of all members.

Public Member Functions
	DtSmEnrollmentMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtSmEnrollmentMsg (DtFederateHandle federateHandle, int fedexHandle, DtSmRegisterFlags action, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtSmEnrollmentMsg (const DtSmRegisterMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtSmEnrollmentMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (DtFederateHandle federateHandle, int fedexHandle, DtSmRegisterFlags action)
	Set all parameters simultaneously.
void	setActionFlag (const DtSmRegisterFlags action)
	Set/Get register / unregister action flag.
const DtSmRegisterFlags	actionFlag () 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, DtSmEnrollmentMsgCb cb, void *usr)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtSmEnrollmentMsgCb cb, void *usr)
Protected Member Functions
virtual DtSmRegisterMsg *	netSmRegisterMsg ()
	The network representation.
virtual const DtSmRegisterMsg *	netSmRegisterMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an SmMulticastConfig Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual DtSmEnrollmentMsg *	self () const
	Casts away const-ness.

---

Detailed Description

IMPORTANT NOTE: Multicast Configuration message are not intended for dissemination over the network.

They are to be exchanged over a shared memory message queue only to allow federates to inform a shared memory queue manager that the federate has subscribed to shared memory queue services.

---

Constructor & Destructor Documentation

DtSmEnrollmentMsg::DtSmEnrollmentMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

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

Referenced by clone(), and create().

DtSmEnrollmentMsg::DtSmEnrollmentMsg	(	DtFederateHandle	federateHandle,
		int	fedexHandle,
		DtSmRegisterFlags	action,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), setActionFlag(), DtRtiMsg::setFederateHandle(), and DtRtiMsg::setFedEx().

DtSmEnrollmentMsg::DtSmEnrollmentMsg	(	const DtSmRegisterMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

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

DtSmEnrollmentMsg::~DtSmEnrollmentMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

const DtSmRegisterFlags DtSmEnrollmentMsg::actionFlag

(

)

const

References netSmRegisterMsg().

Referenced by printData().

void DtSmEnrollmentMsg::addCallback	(	DtConnectionMgr *	conn,
		DtSmEnrollmentMsgCb	cb,
		void *	usr
	)		[static]

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtSmEnrollmentMsgKind.

DtRtiMsg * DtSmEnrollmentMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtSmEnrollmentMsg(), and netSmRegisterMsg().

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

Creator.

References DtSmEnrollmentMsg().

DtRtiMsg * DtSmEnrollmentMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

Creator.

References DtSmEnrollmentMsg().

DtRtiMsgKind DtSmEnrollmentMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of an SmMulticastConfig Msg.

Implements DtRtiMsg.

References DtSmEnrollmentMsgKind.

Referenced by DtSmEnrollmentMsg().

int DtSmEnrollmentMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtSmEnrollmentMsg().

DtSmRegisterMsg * DtSmEnrollmentMsg::netSmRegisterMsg

(

)

[protected, virtual]

The network representation.

Referenced by actionFlag(), clone(), and setActionFlag().

const DtSmRegisterMsg * DtSmEnrollmentMsg::netSmRegisterMsg

(

)

const [protected, virtual]

void DtSmEnrollmentMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References actionFlag(), DtRtiMsg::federateHandle(), and DtRtiMsg::fedExHandle().

void DtSmEnrollmentMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtSmEnrollmentMsgCb	cb,
		void *	usr
	)		[static]

References DtSmEnrollmentMsgKind, and DtConnectionMgr::removeMsgCallback().

DtSmEnrollmentMsg * DtSmEnrollmentMsg::self

(

)

const [inline, protected, virtual]

Casts away const-ness.

void DtSmEnrollmentMsg::set	(	DtFederateHandle	federateHandle,
		int	fedexHandle,
		DtSmRegisterFlags	action
	)		[virtual]

Set all parameters simultaneously.

References setActionFlag(), DtRtiMsg::setFederateHandle(), and DtRtiMsg::setFedEx().

Referenced by DtSmConnectionMgr::connectFederation(), DtSmConnectionMgr::disconnectFederation(), DtSmConnectionMgr::repairFederationConnection(), and DtSmConnectionMgr::~DtSmConnectionMgr().

void DtSmEnrollmentMsg::setActionFlag

(

const DtSmRegisterFlags

action

)

Set/Get register / unregister action flag.

References DtSmRegisterMsg::actionFlag, and netSmRegisterMsg().

Referenced by DtSmEnrollmentMsg(), and set().

---

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

• smEnrollmentMsg.h
• smEnrollmentMsg.cxx