DtJoinConfirmMsg Class Reference

Inheritance diagram for DtJoinConfirmMsg:

Collaboration diagram for DtJoinConfirmMsg:

List of all members.

Public Types
enum	errorCodes {   DtNoError = 0, DtCouldNotCreateTimeFactory, DtFomError, DtTimedOut,   DtCrcMismatch, DtUnknownError }
	error codes for the errorValue flag More...
Public Member Functions
	DtJoinConfirmMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtJoinConfirmMsg (unsigned long sourceIDValue, errorCodes errorCodeValue, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtJoinConfirmMsg (const DtNetJoinConfirmMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtJoinConfirmMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (unsigned long sourceIDValue, errorCodes errorCodeValue)
	Set all fields simultaneously.
virtual unsigned long	sourceID () const
	Set/Get federate connection ID The source ID will uniquely identify the federate.
virtual void	setSourceID (unsigned long sourceIDValue)
virtual void	setErrorCode (errorCodes errorCodeVal)
	Set/Get error code ( by default message will contain address of primary interface )
virtual errorCodes	errorCode () 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, DtJoinConfirmCb cb, void *usr, bool isMomCallback=false)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtJoinConfirmCb cb, void *usr, bool isMomCallback=false)
Protected Member Functions
virtual DtNetJoinConfirmMsg *	netJoinConfirmMsg ()
	The network representation.
virtual const DtNetJoinConfirmMsg *	netJoinConfirmMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Join Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual DtJoinConfirmMsg *	self () const
	Casts away const-ness.

---

Member Enumeration Documentation

enum DtJoinConfirmMsg::errorCodes

error codes for the errorValue flag

Enumerator:

DtNoError
DtCouldNotCreateTimeFactory
DtFomError
DtTimedOut
DtCrcMismatch
DtUnknownError

---

Constructor & Destructor Documentation

DtJoinConfirmMsg::DtJoinConfirmMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

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

Referenced by clone(), and create().

DtJoinConfirmMsg::DtJoinConfirmMsg	(	unsigned long	sourceIDValue,
		errorCodes	errorCodeValue,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

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

DtJoinConfirmMsg::DtJoinConfirmMsg	(	const DtNetJoinConfirmMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

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

DtJoinConfirmMsg::~DtJoinConfirmMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

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

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtJoinConfirmMsgKind.

Referenced by DtFedExec::DtFedExec().

DtRtiMsg * DtJoinConfirmMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtJoinConfirmMsg(), and netJoinConfirmMsg().

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

Creator.

References DtJoinConfirmMsg().

DtRtiMsg * DtJoinConfirmMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

Creator.

References DtJoinConfirmMsg().

DtJoinConfirmMsg::errorCodes DtJoinConfirmMsg::errorCode

(

)

const [virtual]

References DtNetJoinConfirmMsg::errorCode, and netJoinConfirmMsg().

Referenced by DtSmartForwardingProcessor::federateJoined(), printData(), and DtFedExec::processJoinConfirm().

DtRtiMsgKind DtJoinConfirmMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of an Join Msg.

Implements DtRtiMsg.

References DtJoinConfirmMsgKind.

Referenced by DtJoinConfirmMsg().

int DtJoinConfirmMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtJoinConfirmMsg().

DtNetJoinConfirmMsg * DtJoinConfirmMsg::netJoinConfirmMsg

(

)

[protected, virtual]

The network representation.

Referenced by clone(), errorCode(), setErrorCode(), setSourceID(), and sourceID().

const DtNetJoinConfirmMsg * DtJoinConfirmMsg::netJoinConfirmMsg

(

)

const [protected, virtual]

void DtJoinConfirmMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References errorCode(), and sourceID().

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

References DtJoinConfirmMsgKind, and DtConnectionMgr::removeMsgCallback().

Referenced by DtFedExec::~DtFedExec().

DtJoinConfirmMsg * DtJoinConfirmMsg::self

(

)

const [inline, protected, virtual]

Casts away const-ness.

void DtJoinConfirmMsg::set	(	unsigned long	sourceIDValue,
		errorCodes	errorCodeValue
	)		[virtual]

Set all fields simultaneously.

References setErrorCode(), and setSourceID().

Referenced by DtRtiExecFederateMgr::sendJoinConfirmMsg().

void DtJoinConfirmMsg::setErrorCode

(

errorCodes

errorCodeVal

)

[virtual]

Set/Get error code ( by default message will contain address of primary interface )

References DtNetJoinConfirmMsg::errorCode, and netJoinConfirmMsg().

Referenced by set().

void DtJoinConfirmMsg::setSourceID

(

unsigned long

sourceIDValue

)

[virtual]

References netJoinConfirmMsg(), and DtNetJoinConfirmMsg::sourceID.

Referenced by set().

unsigned long DtJoinConfirmMsg::sourceID

(

)

const [virtual]

Set/Get federate connection ID The source ID will uniquely identify the federate.

This is necessary so forwarders can handle JoinConfirm messages which are received via the WAN from another forwarder, not from the federate directly.

References netJoinConfirmMsg(), and DtNetJoinConfirmMsg::sourceID.

Referenced by DtSmartForwardingProcessor::federateJoined(), DtFederateTrackingFilter::handleJoinConfirmMsg(), printData(), and DtFedExec::processJoinConfirm().

---

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

• joinConfMsg.h
• joinConfMsg.cxx