Sent by Federates to request fed file from RtiExec. More...

Inheritance diagram for DtFomModuleRequestMsg:

Collaboration diagram for DtFomModuleRequestMsg:

Public Member Functions
	DtFomModuleRequestMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Default / Send constructor.
	DtFomModuleRequestMsg (unsigned long ID, unsigned long destID, const MAKRti::DtString &fedExNameVal, std::vector< MAKRti::DtString > const &moduleNames, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtFomModuleRequestMsg (const DtNetFomModuleReqMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Recv Constructor (from incoming message)
virtual	~DtFomModuleRequestMsg ()
	Destructor.
DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (unsigned long ID, unsigned long destID, const MAKRti::DtString &fedExNameVal, std::vector< MAKRti::DtString > const &fomModuleName)
void	setSourceID (unsigned long ID)
	Set/Get Source ID.
unsigned long	sourceID () const
void	setDestinationID (unsigned long ID)
	Set/Get Destination Federate ID.
unsigned long	destinationID () const
virtual void	setFullFedExName (const MAKRti::DtString &fedExNameVal)
	Set/Get Federation Name.
virtual MAKRti::DtString	fullFedExName () const
virtual void	setFomModuleNames (std::vector< MAKRti::DtString > const &fomModuleName)
	Set/Get Fom Module Name.
virtual void	getFomModuleNames (std::vector< MAKRti::DtString > &modules) const
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print the data section.
Public Member Functions inherited from DtRtiMsg
virtual	~DtRtiMsg ()
	Destructor.
virtual DtRtiMsg *	cloneWithTransport (bool copy=true) const
	Return a copy/empty object of the same type as this using clone and set the transport type from the host message.
virtual DtNetMsgHeader *	netHeader () const
	Get header of network representation.
virtual int	version () const
	Return the message version.
virtual bool	isValidVersion () const
	Returns bool: message version is valid?
virtual void	setFedEx (const MAKRti::DtString &name)
	All RTI messages contain information to identify which federation execution the message applies to.
virtual void	setFedEx (int handle)
	Set federation execution identifier as a handle.
virtual bool	isForExec (const MAKRti::DtString &execName, int execHandle) const
	Returns true if the current message belongs to the indicated federation execution, false otherwise.
virtual DtRtiMsgKind	msgKind () const
	Get the message kind.
virtual const char *	kindString () const
	Returns the message kind string name.
virtual bool	isConstrained () const
	Return boolean: message type can be time constrained?
virtual bool	isAllowedDuringSave () const
	Return boolean: message type can be processed during save?
virtual void	setTime (const RTI::FedTime &time)
	Set/Get time Used in timestamped messages.
virtual RTI::FedTime const *	time (DtLogicalTimeFactory *fedTimeFactory) const
virtual bool	hasTime () const
	Returns true if time field is valid.
virtual void	setSerialNumber (unsigned long serialNumberValue)
	Set/Get event retraction serial number Used in timestamped messages.
virtual unsigned long	serialNumber () const
virtual void	setTransportType (DtTransportHandle type)
	Set/Get transport type.
virtual DtTransportHandle	transportType () const
virtual DtOrderHandle	orderType () const
	This base implementation always returns recieve order.
virtual bool	isMetadataPresent () const
	Test if metadata has been added to a DtRtiMsg object.
virtual bool	addMetadata (caddr_t mtdAddr, unsigned int size, unsigned int alignPad, unsigned int *headerPad=NULL)
	Allocate space for next block of metadata.
virtual void	removeMetadata (unsigned int size)
	Update the size of the message when metadata has been removed.
bool	isInteractionMsgType () const
	Utility functions, check the message type against known interaciton/update message types.
bool	isUpdateMsgType () const
virtual void	print (DtLogicalTimeFactory *logicalTimeFactory) const
	Printing functions.
virtual void	printHeader (DtLogicalTimeFactory *logicalTimeFactory) const
virtual void	printTime (const char label, RTI::FedTime const timeValue) const
	Print the given time.
virtual void	printInterval (const char label, RTI::FedTime const intervalValue) const
	Print the interval.
virtual int	status () const
	Returns MSG_STATUS_OK if OK, a reason enumeration otherwise.
virtual const MAKRti::DtString	fedExName () const
	These two functions should be avoided in favor of isForExec().
virtual int	fedExHandle () const
	Get the federation execution identifier as a handle Returns 0 if the identifier is being represented as a name.
virtual void	setFederateHandle (DtFederateHandle handle)
	Set/Get federate handle.
virtual DtFederateHandle	federateHandle () const
	Set/Get federate handle.
virtual void	setSequenceNumber (unsigned long value)
	Set/Get message sequence number.
virtual unsigned long	sequenceNumber () const
	Set/Get message sequence number.
virtual void	setServiceCallNumber (unsigned long value)
	Set/Get service call number.
virtual unsigned long	serviceCallNumber () const
	Set/Get service call number.
virtual void	setTriggerMessageNumber (unsigned long value)
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).
virtual unsigned long	triggerMessageNumber () const
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).

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, DtFomModuleReqCb cb, void usr)
	Add / Remove Callbacks.
static void	removeCallback (DtConnectionMgr conn, DtFomModuleReqCb cb, void usr)
Static Public Member Functions inherited from DtRtiMsg
static const DtNetMsgHeader *	netHeader (const void *buffer)
	Extracts the header network representation from the buffer.
static const char *	kindToString (DtRtiMsgKind kind)
	Returns the name of the message, by kind enumeration.
static const char *	kindString (const void *buffer)
	Extracts the message kind from the given buffer and returns its string name.
static const DtRtiMsgKind	msgKind (const void *buffer)
	Extracts the message kind from the given buffer.
static unsigned int	version (const void *buffer)
	Extracts the message version form the given buffer.
static unsigned int	fedExHandle (const void *buffer)
	Extracts the message fedEx handle form the given buffer (0 if lightweight fedEx name)
static DtFederateHandle	federateHandle (const void *buffer)
	Extracts the message federate handle form the given buffer.
static unsigned long	sequenceNumber (const void *buffer)
	Extracts the message sequence number form the given buffer.
static void	setDefaultRegionSet (unsigned long defaultRegionSet)
	Set the default region set handle.
static void	setUse32BitsForValueSize (bool use32BitsForValueSizeEnabled)
	Set/Get flag to enable use of 32 bit size field for attribute/parameter values.
static bool	use32BitsForValueSize ()
static void	setSmartForwardingEnabled (bool enabled)
	Set/Get is SmartForwarding enabled?
static bool	smartForwardingEnabled ()

Protected Member Functions
virtual const DtNetFomModuleReqMsg *	netFomModuleReqMsg () const
	The network representation.
virtual DtNetFomModuleReqMsg *	netFomModuleReqMsg ()
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Create Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual int	setMinSizes (const MAKRti::DtString &fedExNameVal, std::vector< MAKRti::DtString > const &fomModulesNamesVal)
	Sets the field sizes for the variant components and returns the minimum size needed for the message, including header DOES NOT allocate memory for the components.
virtual void	setFedExNameSize (unsigned long size)
	Set/Get fedExNameSize.
virtual unsigned int	fedExNameSize () const
virtual void	setFomModuleNameSize (unsigned long size)
	Set/Get fed fomModuleName size.
virtual unsigned int	fomModuleNameSize () const
virtual char *	fedExNamePtr ()
	Return pointer to component location in message.
virtual char *	fomModuleNamesPtr ()
virtual const char *	fedExNamePtr () const
	Const version: Return pointer to component location in message.
virtual const char *	fomModuleNamesPtr () const
virtual DtFomModuleRequestMsg *	self () const
Protected Member Functions inherited from DtRtiMsg
	DtRtiMsg ()
	Constructor.
virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes.
void	initDtRtiMsg (int size, DtRtiMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual.
void	initDtRtiMsg (const void *initial, int size, DtBufferPtr buffer)
void	initDtRtiMsg (const DtNetMsgHeader *header, DtBufferPtr buffer)
virtual void	adjustBytes (int offset, int numBytes)
	Adjust numBytes bytes at the indicated offset in the net rep.
virtual void	adjustBytes (void *address, int numBytes)
	Adjust the numBytes starting at the indicated addres.

Additional Inherited Members
Static Public Attributes inherited from DtRtiMsg
static unsigned long	theDefaultRegionSetHandle = 0
static const char *	theDefaultTag = NULL
Protected Attributes inherited from DtRtiMsg
DtTransportHandle	myTransportType
DtOrderHandle	myOrderType
RTI::FedTime *	myFedTime
bool	myTimeIsValid
bool	myConstrained
bool	myAllowedDuringSave
unsigned long	mySerialNumber
unsigned long	myServiceCallNumber
unsigned long	myTriggerMessage
Static Protected Attributes inherited from DtRtiMsg
static bool	theUse32BitsForValueSize = false
static bool	theSmartForwardingEnabled = false

Detailed Description

Sent by Federates to request fed file from RtiExec.

Constructor & Destructor Documentation

DtFomModuleRequestMsg::DtFomModuleRequestMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Default / Send constructor.

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

Referenced by clone(), create(), minSize(), and setMinSizes().

DtFomModuleRequestMsg::DtFomModuleRequestMsg	(	unsigned long	ID,
		unsigned long	destID,
		const MAKRti::DtString &	fedExNameVal,
		std::vector< MAKRti::DtString > const &	moduleNames,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), setDestinationID(), setFomModuleNames(), setFullFedExName(), setMinSizes(), and setSourceID().

DtFomModuleRequestMsg::DtFomModuleRequestMsg	(	const DtNetFomModuleReqMsg *	netRepMsg,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

Recv Constructor (from incoming message)

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

DtFomModuleRequestMsg::~DtFomModuleRequestMsg ( )

virtual

Destructor.

Member Function Documentation

void DtFomModuleRequestMsg::addCallback	(	DtConnectionMgr *	conn,
		DtFomModuleReqCb	cb,
		void *	usr
	)

static

Add / Remove Callbacks.

References DtConnectionMgr::addMsgCallback(), and DtFomModuleRequestMsgKind.

Referenced by DtFedExec::createDistributor(), and DtRtiExecFederateMgr::init().

DtRtiMsg * DtFomModuleRequestMsg::clone ( bool copy = true ) const

virtual

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

Implements DtRtiMsg.

References DtFomModuleRequestMsg(), and netFomModuleReqMsg().

DtRtiMsg * DtFomModuleRequestMsg::create	(	const DtNetMsgHeader *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

static

Creator for receiving.

References DtFomModuleRequestMsg().

DtRtiMsg * DtFomModuleRequestMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

static

Creator for sending.

References DtFomModuleRequestMsg().

unsigned long DtFomModuleRequestMsg::destinationID ( ) const

References DtNetFomModuleReqMsg::destinationID, and netFomModuleReqMsg().

Referenced by DtFileDistributor::fileRequested(), DtFedExec::multFileRequestedCb(), printData(), and DtRtiExecFederateMgr::processFomModuleFileRequestMsg().

char * DtFomModuleRequestMsg::fedExNamePtr ( )

protectedvirtual

Return pointer to component location in message.

References netFomModuleReqMsg().

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

const char * DtFomModuleRequestMsg::fedExNamePtr ( ) const

protectedvirtual

Const version: Return pointer to component location in message.

References netFomModuleReqMsg().

unsigned int DtFomModuleRequestMsg::fedExNameSize ( ) const

protectedvirtual

References DtNetFomModuleReqMsg::fedExNameSize, and netFomModuleReqMsg().

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

unsigned int DtFomModuleRequestMsg::fomModuleNameSize ( ) const

protectedvirtual

References DtNetFomModuleReqMsg::fomModuleNameSize, and netFomModuleReqMsg().

Referenced by setFomModuleNames().

char * DtFomModuleRequestMsg::fomModuleNamesPtr ( )

protectedvirtual

References fedExNamePtr(), and fedExNameSize().

Referenced by getFomModuleNames(), and setFomModuleNames().

const char * DtFomModuleRequestMsg::fomModuleNamesPtr ( ) const

protectedvirtual

References fedExNamePtr(), and fedExNameSize().

MAKRti::DtString DtFomModuleRequestMsg::fullFedExName ( ) const

virtual

References fedExNamePtr(), and fedExNameSize().

Referenced by DtFileDistributor::fileRequested(), printData(), and DtRtiExecFederateMgr::processFomModuleFileRequestMsg().

void DtFomModuleRequestMsg::getFomModuleNames ( std::vector< MAKRti::DtString > & modules ) const

virtual

References fomModuleNamesPtr(), netFomModuleReqMsg(), and DtNetFomModuleReqMsg::numFomModules.

Referenced by DtSynchronousFileDistributor::multFileRequestedCb(), printData(), DtAsyncFileDistributorRunnable::processFileRequested(), and DtRtiExecFederateMgr::processFomModuleFileRequestMsg().

DtRtiMsgKind DtFomModuleRequestMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an Create Msg.

Implements DtRtiMsg.

References DtFomModuleRequestMsgKind.

Referenced by DtFomModuleRequestMsg().

int DtFomModuleRequestMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

References DtFomModuleRequestMsg().

Referenced by DtFomModuleRequestMsg(), and set().

const DtNetFomModuleReqMsg * DtFomModuleRequestMsg::netFomModuleReqMsg ( ) const

protectedvirtual

The network representation.

Referenced by clone(), destinationID(), fedExNamePtr(), fedExNameSize(), fomModuleNameSize(), getFomModuleNames(), printData(), set(), setDestinationID(), setFedExNameSize(), setFomModuleNames(), setFomModuleNameSize(), setFullFedExName(), setSourceID(), and sourceID().

DtNetFomModuleReqMsg * DtFomModuleRequestMsg::netFomModuleReqMsg ( )

protectedvirtual

void DtFomModuleRequestMsg::printData ( DtLogicalTimeFactory * logicalTimeFactory ) const

virtual

Print the data section.

Reimplemented from DtRtiMsg.

References destinationID(), fullFedExName(), getFomModuleNames(), netFomModuleReqMsg(), and sourceID().

void DtFomModuleRequestMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtFomModuleReqCb	cb,
		void *	usr
	)

static

References DtFomModuleRequestMsgKind, and DtConnectionMgr::removeMsgCallback().

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

DtFomModuleRequestMsg * DtFomModuleRequestMsg::self ( ) const

inlineprotectedvirtual

void DtFomModuleRequestMsg::set	(	unsigned long	ID,
		unsigned long	destID,
		const MAKRti::DtString &	fedExNameVal,
		std::vector< MAKRti::DtString > const &	fomModuleName
	)

virtual

References rti1516e::insertBytes(), minSize(), netFomModuleReqMsg(), setDestinationID(), setFomModuleNames(), setFullFedExName(), setMinSizes(), and setSourceID().

Referenced by DtFedExec::processFedFileRequestMsg(), and DtSynchronousFileDistributor::pullEntireFedFile().

void DtFomModuleRequestMsg::setDestinationID ( unsigned long ID )

Set/Get Destination Federate ID.

References DtNetFomModuleReqMsg::destinationID, and netFomModuleReqMsg().

Referenced by DtFomModuleRequestMsg(), and set().

void DtFomModuleRequestMsg::setFedExNameSize ( unsigned long size )

protectedvirtual

Set/Get fedExNameSize.

References DtNetFomModuleReqMsg::fedExNameSize, and netFomModuleReqMsg().

Referenced by setMinSizes().

void DtFomModuleRequestMsg::setFomModuleNames ( std::vector< MAKRti::DtString > const & fomModuleName )

virtual

Set/Get Fom Module Name.

References DtNetFomModuleReqMsg::fomModuleNameSize, fomModuleNameSize(), fomModuleNamesPtr(), rti1516e::insertBytes(), netFomModuleReqMsg(), and DtNetFomModuleReqMsg::numFomModules.

Referenced by DtFomModuleRequestMsg(), and set().

void DtFomModuleRequestMsg::setFomModuleNameSize ( unsigned long size )

protectedvirtual

Set/Get fed fomModuleName size.

References DtNetFomModuleReqMsg::fomModuleNameSize, and netFomModuleReqMsg().

Referenced by setMinSizes().

void DtFomModuleRequestMsg::setFullFedExName ( const MAKRti::DtString & fedExNameVal )

virtual

Set/Get Federation Name.

References fedExNamePtr(), DtNetFomModuleReqMsg::fedExNameSize, fedExNameSize(), rti1516e::insertBytes(), and netFomModuleReqMsg().

Referenced by DtFomModuleRequestMsg(), and set().

int DtFomModuleRequestMsg::setMinSizes	(	const MAKRti::DtString &	fedExNameVal,
		std::vector< MAKRti::DtString > const &	fomModulesNamesVal
	)

protectedvirtual

Sets the field sizes for the variant components and returns the minimum size needed for the message, including header DOES NOT allocate memory for the components.

References DtFomModuleRequestMsg(), setFedExNameSize(), and setFomModuleNameSize().

Referenced by DtFomModuleRequestMsg(), and set().

void DtFomModuleRequestMsg::setSourceID ( unsigned long ID )

Set/Get Source ID.

References netFomModuleReqMsg(), and DtNetFomModuleReqMsg::sourceID.

Referenced by DtFomModuleRequestMsg(), and set().

unsigned long DtFomModuleRequestMsg::sourceID ( ) const

References netFomModuleReqMsg(), and DtNetFomModuleReqMsg::sourceID.

Referenced by DtSynchronousFileDistributor::multFileRequestedCb(), DtFedExec::multFileRequestedCb(), printData(), and DtAsyncFileDistributorRunnable::processFileRequested().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation