DtTransferRidParamsMsg Class Reference

Sent by Federates to request testing of the RID file from RtiExec. More...

Inheritance diagram for DtTransferRidParamsMsg:

Collaboration diagram for DtTransferRidParamsMsg:

List of all members.

Public Member Functions
	DtTransferRidParamsMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Default / Send constructor.
	DtTransferRidParamsMsg (const DtNetTransferRidParamsMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Recv Constructor (from incoming message)
virtual	~DtTransferRidParamsMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual int	minSize () const
virtual void	setDestinationID (const DtFederateHandle &destination)
	Set/Get destination Federate Id ( 0 == RtiExec )
virtual DtFederateHandle	destinationID () const
virtual void	writeRidTestBlock (const char *ridTestBlock, unsigned int blockSize)
	Write / Read Rid Test block contents.
virtual const char *	readRidTestBlock () 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 for receiving.
static DtRtiMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creator for sending.
static void	addCallback (DtConnectionMgr *conn, DtRidTestRespCb cb, void *usr)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtRidTestRespCb cb, void *usr)
Protected Member Functions
virtual DtNetTransferRidParamsMsg *	netTransferMsg ()
	The network representation.
virtual const DtNetTransferRidParamsMsg *	netTransferMsg () const
virtual char *	fileBufferPtr () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Create Msg.
virtual DtTransferRidParamsMsg *	self () const
	Casts away const-ness.

---

Detailed Description

Sent by Federates to request testing of the RID file from RtiExec.

---

Constructor & Destructor Documentation

DtTransferRidParamsMsg::DtTransferRidParamsMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Default / Send constructor.

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

Referenced by clone(), and create().

DtTransferRidParamsMsg::DtTransferRidParamsMsg	(	const DtNetTransferRidParamsMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Recv Constructor (from incoming message)

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

DtTransferRidParamsMsg::~DtTransferRidParamsMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtTransferRidParamsMsg::addCallback	(	DtConnectionMgr *	conn,
		DtRidTestRespCb	cb,
		void *	usr
	)		[static]

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtTransferRidParamsMsgKind.

Referenced by DtRidFileTester::DtRidFileTester().

DtRtiMsg * DtTransferRidParamsMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtTransferRidParamsMsg(), and netTransferMsg().

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

Creator for receiving.

References DtTransferRidParamsMsg().

DtRtiMsg * DtTransferRidParamsMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

Creator for sending.

References DtTransferRidParamsMsg().

DtFederateHandle DtTransferRidParamsMsg::destinationID

(

)

const [virtual]

References DtNetTransferRidParamsMsg::destination, and netTransferMsg().

Referenced by printData(), and DtRidFileTester::ridResponseCb().

char * DtTransferRidParamsMsg::fileBufferPtr

(

)

const [protected, virtual]

References DtNetTransferRidParamsMsg::fileBuffer, and netTransferMsg().

Referenced by printData(), readRidTestBlock(), and writeRidTestBlock().

DtRtiMsgKind DtTransferRidParamsMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of an Create Msg.

Implements DtRtiMsg.

References DtTransferRidParamsMsgKind.

Referenced by DtTransferRidParamsMsg().

int DtTransferRidParamsMsg::minSize

(

)

const [virtual]

Referenced by DtTransferRidParamsMsg().

DtNetTransferRidParamsMsg * DtTransferRidParamsMsg::netTransferMsg

(

)

[protected, virtual]

The network representation.

Referenced by clone(), destinationID(), fileBufferPtr(), and setDestinationID().

const DtNetTransferRidParamsMsg * DtTransferRidParamsMsg::netTransferMsg

(

)

const [protected, virtual]

void DtTransferRidParamsMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References destinationID(), and fileBufferPtr().

const char * DtTransferRidParamsMsg::readRidTestBlock

(

)

const [virtual]

References fileBufferPtr().

Referenced by DtRidFileTester::ridResponseCb().

void DtTransferRidParamsMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtRidTestRespCb	cb,
		void *	usr
	)		[static]

References DtTransferRidParamsMsgKind, and DtConnectionMgr::removeMsgCallback().

Referenced by DtRidFileTester::~DtRidFileTester().

DtTransferRidParamsMsg * DtTransferRidParamsMsg::self

(

)

const [inline, protected, virtual]

Casts away const-ness.

void DtTransferRidParamsMsg::setDestinationID

(

const DtFederateHandle &

destination

)

[virtual]

Set/Get destination Federate Id ( 0 == RtiExec )

References DtNetTransferRidParamsMsg::destination, and netTransferMsg().

Referenced by DtRtiExec::ridRequestCb(), and DtFedExec::sendTransferRidParamsMsg().

void DtTransferRidParamsMsg::writeRidTestBlock	(	const char *	ridTestBlock,
		unsigned int	blockSize
	)		[virtual]

Write / Read Rid Test block contents.

References fileBufferPtr(), and rti1516e::insertBytes().

Referenced by DtRtiExec::ridRequestCb(), and DtFedExec::sendTransferRidParamsMsg().

---

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

• transferRidParamsMsg.h
• transferRidParamsMsg.cxx