DtFomModuleDistributionMsg Class Reference

Inheritance diagram for DtFomModuleDistributionMsg:

Collaboration diagram for DtFomModuleDistributionMsg:

List of all members.

Public Member Functions
	DtFomModuleDistributionMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Default / Send constructor.
	DtFomModuleDistributionMsg (const DtNetFedFileMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Recv Constructor (from incoming message)
virtual	~DtFomModuleDistributionMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	setFomModuleName (const MAKRti::DtString &fileName)
	Set/Get FomModuleName.
virtual MAKRti::DtString	fomModuleName () const
virtual unsigned int	fomModuleNameLength () const
	Get FomModuleName buffer size.
virtual void	setFullFedExName (const MAKRti::DtString &fedExName)
	Set/Get Federation Name.
virtual MAKRti::DtString	fullFedExName () const
virtual unsigned int	fedExNameLength () const
	Get FedExName buffer size.
virtual void	setBlock (unsigned short numBlocks, unsigned short seqNum, unsigned short blockLength, const char *fomModuleBlock)
	Set Block Size, Num Blocks, Seq. Num, and data.
virtual void	setDestination (const DtFederateHandle &destination)
	Set/Get destination Federate Id ( 0 == RtiExec )
virtual DtFederateHandle	destination () const
virtual void	setSourceID (unsigned long ID)
	Set/Get Source ID.
virtual unsigned long	sourceID () const
virtual void	setBlockSize (unsigned short blockLength)
	Set/Get Fed File length of block contained in this msg (up to max MAKRti::DtNetU16)
virtual unsigned short	blockSize () const
virtual void	setSequenceNum (unsigned short seqNum)
	Set/Get sequence number of this message's block.
virtual unsigned short	seqNum () const
virtual void	setNumFomModuleBlocks (unsigned short numBlocks)
	Set/Get number of blocks the Fed File has been broken into.
virtual unsigned short	numFomModuleBlocks () const
virtual void	writeFomModuleBlock (const char *fomModuleBlock)
	Write / Read Fed File block contents.
virtual const char *	readFomModuleBlock () 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, DtFomModuleDistCb cb, void *usr)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtFomModuleDistCb cb, void *usr)
Protected Member Functions
virtual DtNetFedFileMsg *	netFomModuleMsg ()
	The network representation.
virtual const DtNetFedFileMsg *	netFomModuleMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Create Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual char *	fileNamePtr () const
	Insertion pointers for file name string and file buffer in netRep()
virtual char *	fedExNamePtr () const
virtual char *	fileBufferPtr () const
virtual DtFomModuleDistributionMsg *	self () const
	Casts away const-ness.

---

Constructor & Destructor Documentation

DtFomModuleDistributionMsg::DtFomModuleDistributionMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Default / Send constructor.

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

Referenced by clone(), and create().

DtFomModuleDistributionMsg::DtFomModuleDistributionMsg	(	const DtNetFedFileMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Recv Constructor (from incoming message)

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

DtFomModuleDistributionMsg::~DtFomModuleDistributionMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtFomModuleDistributionMsg::addCallback	(	DtConnectionMgr *	conn,
		DtFomModuleDistCb	cb,
		void *	usr
	)		[static]

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtFomModuleDistributionMsgKind.

Referenced by DtFedExec::createDistributor(), and DtSynchronousFileDistributor::DtSynchronousFileDistributor().

unsigned short DtFomModuleDistributionMsg::blockSize

(

)

const [virtual]

References DtNetFedFileMsg::curBlockSize, and netFomModuleMsg().

Referenced by DtFileDistributor::fileReceived(), printData(), and writeFomModuleBlock().

DtRtiMsg * DtFomModuleDistributionMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtFomModuleDistributionMsg(), and netFomModuleMsg().

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

Creator for receiving.

References DtFomModuleDistributionMsg().

DtRtiMsg * DtFomModuleDistributionMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

Creator for sending.

References DtFomModuleDistributionMsg().

DtFederateHandle DtFomModuleDistributionMsg::destination

(

)

const [virtual]

References DtNetFedFileMsg::destination, and netFomModuleMsg().

Referenced by DtFileDistributor::fileReceived(), DtFedExec::multFileReceivedCb(), printData(), and setDestination().

unsigned int DtFomModuleDistributionMsg::fedExNameLength

(

)

const [virtual]

Get FedExName buffer size.

References DtNetFedFileMsg::fedExNameLength, and netFomModuleMsg().

Referenced by fileBufferPtr(), and setFullFedExName().

char * DtFomModuleDistributionMsg::fedExNamePtr

(

)

const [protected, virtual]

References fileNamePtr(), and fomModuleNameLength().

Referenced by fileBufferPtr(), fullFedExName(), and setFullFedExName().

char * DtFomModuleDistributionMsg::fileBufferPtr

(

)

const [protected, virtual]

References fedExNameLength(), and fedExNamePtr().

Referenced by readFomModuleBlock(), and writeFomModuleBlock().

char * DtFomModuleDistributionMsg::fileNamePtr

(

)

const [protected, virtual]

Insertion pointers for file name string and file buffer in netRep()

References netFomModuleMsg().

Referenced by fedExNamePtr(), fomModuleName(), and setFomModuleName().

MAKRti::DtString DtFomModuleDistributionMsg::fomModuleName

(

)

const [virtual]

References fileNamePtr(), and minSize().

Referenced by DtFileDistributor::fileReceived(), DtSynchronousFileDistributor::multFileReceivedCb(), printData(), and DtAsyncFileDistributorRunnable::processFileReceived().

unsigned int DtFomModuleDistributionMsg::fomModuleNameLength

(

)

const [virtual]

Get FomModuleName buffer size.

References DtNetFedFileMsg::fileNameLength, and netFomModuleMsg().

Referenced by fedExNamePtr(), printData(), and setFomModuleName().

MAKRti::DtString DtFomModuleDistributionMsg::fullFedExName

(

)

const [virtual]

References fedExNamePtr(), and minSize().

Referenced by DtFileDistributor::fileReceived(), DtFedExec::multFileReceivedCb(), and printData().

DtRtiMsgKind DtFomModuleDistributionMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of an Create Msg.

Implements DtRtiMsg.

References DtFomModuleDistributionMsgKind.

Referenced by DtFomModuleDistributionMsg().

int DtFomModuleDistributionMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtFomModuleDistributionMsg(), fomModuleName(), and fullFedExName().

DtNetFedFileMsg * DtFomModuleDistributionMsg::netFomModuleMsg

(

)

[protected, virtual]

The network representation.

Referenced by blockSize(), clone(), destination(), fedExNameLength(), fileNamePtr(), fomModuleNameLength(), numFomModuleBlocks(), seqNum(), setBlockSize(), setDestination(), setFomModuleName(), setFullFedExName(), setNumFomModuleBlocks(), setSequenceNum(), setSourceID(), and sourceID().

const DtNetFedFileMsg * DtFomModuleDistributionMsg::netFomModuleMsg

(

)

const [protected, virtual]

unsigned short DtFomModuleDistributionMsg::numFomModuleBlocks

(

)

const [virtual]

References netFomModuleMsg(), and DtNetFedFileMsg::numBlocks.

Referenced by DtFileDistributor::fileReceived(), and printData().

void DtFomModuleDistributionMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References blockSize(), destination(), fomModuleName(), fomModuleNameLength(), fullFedExName(), numFomModuleBlocks(), seqNum(), and sourceID().

const char * DtFomModuleDistributionMsg::readFomModuleBlock

(

)

const [virtual]

References fileBufferPtr().

Referenced by DtFileDistributor::fileReceived().

void DtFomModuleDistributionMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtFomModuleDistCb	cb,
		void *	usr
	)		[static]

References DtFomModuleDistributionMsgKind, and DtConnectionMgr::removeMsgCallback().

Referenced by DtFedExec::destroyDistributor(), and DtSynchronousFileDistributor::~DtSynchronousFileDistributor().

DtFomModuleDistributionMsg * DtFomModuleDistributionMsg::self

(

)

const [inline, protected, virtual]

Casts away const-ness.

unsigned short DtFomModuleDistributionMsg::seqNum

(

)

const [virtual]

References netFomModuleMsg(), and DtNetFedFileMsg::sequenceNum.

Referenced by DtFileDistributor::fileReceived(), printData(), and setSequenceNum().

void DtFomModuleDistributionMsg::setBlock	(	unsigned short	numBlocks,
		unsigned short	seqNum,
		unsigned short	blockLength,
		const char *	fomModuleBlock
	)		[virtual]

Set Block Size, Num Blocks, Seq. Num, and data.

References setBlockSize(), setNumFomModuleBlocks(), setSequenceNum(), and writeFomModuleBlock().

Referenced by DtFileDistributor::pushFedFile().

void DtFomModuleDistributionMsg::setBlockSize

(

unsigned short

blockLength

)

[virtual]

Set/Get Fed File length of block contained in this msg (up to max MAKRti::DtNetU16)

References DtNetFedFileMsg::curBlockSize, and netFomModuleMsg().

Referenced by setBlock().

void DtFomModuleDistributionMsg::setDestination

(

const DtFederateHandle &

destination

)

[virtual]

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

References DtNetFedFileMsg::destination, destination(), and netFomModuleMsg().

Referenced by DtFileDistributor::pushFedFile().

void DtFomModuleDistributionMsg::setFomModuleName

(

const MAKRti::DtString &

fileName

)

[virtual]

Set/Get FomModuleName.

References DtNetFedFileMsg::fileNameLength, fileNamePtr(), fomModuleNameLength(), rti1516e::insertBytes(), and netFomModuleMsg().

Referenced by DtFileDistributor::pushFedFile().

void DtFomModuleDistributionMsg::setFullFedExName

(

const MAKRti::DtString &

fedExName

)

[virtual]

Set/Get Federation Name.

References DtNetFedFileMsg::fedExNameLength, fedExNameLength(), fedExNamePtr(), rti1516e::insertBytes(), and netFomModuleMsg().

Referenced by DtFileDistributor::pushFedFile().

void DtFomModuleDistributionMsg::setNumFomModuleBlocks

(

unsigned short

numBlocks

)

[virtual]

Set/Get number of blocks the Fed File has been broken into.

References netFomModuleMsg(), and DtNetFedFileMsg::numBlocks.

Referenced by setBlock().

void DtFomModuleDistributionMsg::setSequenceNum

(

unsigned short

seqNum

)

[virtual]

Set/Get sequence number of this message's block.

References netFomModuleMsg(), seqNum(), and DtNetFedFileMsg::sequenceNum.

Referenced by setBlock().

void DtFomModuleDistributionMsg::setSourceID

(

unsigned long

ID

)

[virtual]

Set/Get Source ID.

References netFomModuleMsg(), and DtNetFedFileMsg::sourceID.

Referenced by DtFileDistributor::pushFedFile().

unsigned long DtFomModuleDistributionMsg::sourceID

(

)

const [virtual]

References netFomModuleMsg(), and DtNetFedFileMsg::sourceID.

Referenced by DtFileDistributor::fileReceived(), DtFedExec::multFileReceivedCb(), and printData().

void DtFomModuleDistributionMsg::writeFomModuleBlock

(

const char *

fomModuleBlock

)

[virtual]

Write / Read Fed File block contents.

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

Referenced by setBlock().

---

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

• fomModuleDistributionMsg.h
• fomModuleDistributionMsg.cxx