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. More...

	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) More...

virtual	~DtFomModuleRequestMsg ()
	Destructor. More...

DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this. More...

virtual void	set (unsigned long ID, unsigned long destID, const MAKRti::DtString &fedExNameVal, std::vector< MAKRti::DtString > const &fomModuleName, bool adjustBufferSize=true)

void	setSourceID (unsigned long ID)
	Set/Get Source ID. More...

unsigned long	sourceID () const

void	setDestinationID (unsigned long ID)
	Set/Get Destination Federate ID. More...

unsigned long	destinationID () const

virtual void	setFullFedExName (const MAKRti::DtString &fedExNameVal, bool adjustBufferSize=true)
	Set/Get Federation Name (adjust buffer size if not pre-allocated for this data). More...

virtual MAKRti::DtString	fullFedExName () const

virtual void	setFomModuleNames (std::vector< MAKRti::DtString > const &fomModuleName, bool adjustBufferSize=true)
	Set/Get Fom Module Name (adjust buffer size if not pre-allocated for this data). More...

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

virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print the data section. More...

Public Member Functions inherited from DtRtiMsg
virtual	~DtRtiMsg ()
	Destructor. More...

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. More...

virtual DtNetMsgHeader *	netHeader () const
	Get header of network representation. More...

virtual int	version () const
	Return the message version. More...

virtual bool	isValidVersion () const
	Returns bool: message version is valid? More...

virtual void	setFedEx (const MAKRti::DtString &name)
	All RTI messages contain information to identify which federation execution the message applies to. More...

virtual void	setFedEx (int handle)
	Set federation execution identifier as a handle. More...

virtual bool	isForExec (const MAKRti::DtString &execName, int execHandle) const
	Returns true if the current message belongs to the indicated federation execution, false otherwise. More...

virtual DtRtiMsgKind	msgKind () const
	Get the message kind. More...

virtual const char *	kindString () const
	Returns the message kind string name. More...

virtual bool	isConstrained () const
	Return boolean: message type can be time constrained? More...

virtual bool	isAllowedDuringSave () const
	Return boolean: message type can be processed during save? More...

virtual void	setTime (const DtRtiApiTime &time)
	Set/Get time Used in timestamped messages. More...

virtual DtRtiApiTime const *	time (DtLogicalTimeFactory *fedTimeFactory) const

virtual bool	hasTime () const
	Returns true if time field is valid. More...

virtual void	setSerialNumber (unsigned long serialNumberValue)
	Set/Get event retraction serial number Used in timestamped messages. More...

virtual unsigned long	serialNumber () const

virtual void	setTransportType (DtTransportHandle type)
	Set/Get transport type. More...

virtual DtTransportHandle	transportType () const

virtual DtOrderHandle	orderType () const
	This base implementation always returns recieve order. More...

virtual bool	isMetadataPresent () const
	Test if metadata has been added to a DtRtiMsg object. More...

virtual bool	addMetadata (caddr_t mtdAddr, unsigned int size, unsigned int alignPad, unsigned int *headerPad=NULL)
	Allocate space for next block of metadata. More...

virtual void	removeMetadata (unsigned int size)
	Update the size of the message when metadata has been removed. More...

bool	isInteractionMsgType () const
	Utility functions, check the message type against known interaciton/update message types. More...

bool	isUpdateMsgType () const

virtual void	print (DtLogicalTimeFactory *logicalTimeFactory) const
	Printing functions. More...

virtual void	printHeader (DtLogicalTimeFactory *logicalTimeFactory) const

virtual void	printTime (const char label, DtRtiApiTime const timeValue) const
	Print the given time. More...

virtual void	printInterval (const char label, DtRtiApiTimeInterval const intervalValue) const
	Print the interval. More...

virtual int	status () const
	Returns MSG_STATUS_OK if OK, a reason enumeration otherwise. More...

virtual int	timeFieldSize (int encodedLength) const
	Returns size of a timestamp field (including byte alignment adjustment) given the time's encoded length. More...

virtual int	tagFieldSize (int encodedLength) const
	Returns size of a tag field (including byte alignment adjustment) given the tag's encoded length. More...

virtual const MAKRti::DtString	fedExName () const
	These two functions should be avoided in favor of isForExec(). More...

virtual int	fedExHandle () const
	Get the federation execution identifier as a handle Returns 0 if the identifier is being represented as a name. More...

virtual void	setFederateHandle (DtFederateHandle handle)
	Set/Get federate handle. More...

virtual DtFederateHandle	federateHandle () const
	Set/Get federate handle. More...

virtual void	setSequenceNumber (unsigned long value)
	Set/Get message sequence number. More...

virtual unsigned long	sequenceNumber () const
	Set/Get message sequence number. More...

virtual void	setServiceCallNumber (unsigned long value)
	Set/Get service call number. More...

virtual unsigned long	serviceCallNumber () const
	Set/Get service call number. More...

virtual void	setTriggerMessageNumber (unsigned long value)
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent). More...

virtual unsigned long	triggerMessageNumber () const
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent). More...

Static Public Member Functions
static DtRtiMsg *	create (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creator for receiving. More...

static DtRtiMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creator for sending. More...

static void	addCallback (DtConnectionMgr conn, DtFomModuleReqCb cb, void usr)
	Add / Remove Callbacks. More...

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. More...

static const char *	kindToString (DtRtiMsgKind kind)
	Returns the name of the message, by kind enumeration. More...

static const char *	kindString (const void *buffer)
	Extracts the message kind from the given buffer and returns its string name. More...

static unsigned long	totalSize (const void *buffer)
	Extracts the message total size form the given buffer. More...

static const DtRtiMsgKind	msgKind (const void *buffer)
	Extracts the message kind from the given buffer. More...

static unsigned int	version (const void *buffer)
	Extracts the message version form the given buffer. More...

static unsigned int	fedExHandle (const void *buffer)
	Extracts the message fedEx handle form the given buffer (0 if lightweight fedEx name) More...

static DtFederateHandle	federateHandle (const void *buffer)
	Extracts the message federate handle form the given buffer. More...

static unsigned long	sequenceNumber (const void *buffer)
	Extracts the message sequence number form the given buffer. More...

static unsigned char	flags (const void *buffer)
	Extracts the message flags form the given buffer. More...

static unsigned long	metadataSize (const void *buffer)
	Extracts the message metadata size form the given buffer. More...

static void	setDefaultRegionSet (unsigned long defaultRegionSet)
	Set the default region set handle. More...

static void	setUse32BitsForValueSize (bool use32BitsForValueSizeEnabled)
	Set/Get flag to enable use of 32 bit size field for attribute/parameter values. More...

static bool	use32BitsForValueSize ()

static void	setSmartForwardingEnabled (bool enabled)
	Set/Get is SmartForwarding enabled? More...

static bool	smartForwardingEnabled ()

Protected Member Functions
virtual const DtNetFomModuleReqMsg *	netFomModuleReqMsg () const
	The network representation. More...

virtual DtNetFomModuleReqMsg *	netFomModuleReqMsg ()

virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Create Msg. More...

virtual int	minSize () const
	Returns minimum size of a message, including header. More...

virtual int	minSize (const MAKRti::DtString &fedExNameVal, std::vector< MAKRti::DtString > const &fomModulesNamesVal)
	Return the buffer size needed for this message with the given variable data. More...

virtual void	setFedExNameSize (unsigned long size)
	Set/Get fedExNameSize. More...

virtual unsigned int	fedExNameSize () const

virtual void	setFomModuleNamesSize (unsigned long size)
	Set/Get fed fomModuleName size. More...

virtual unsigned int	fomModuleNamesSize () const

virtual char *	fedExNamePtr ()
	Return pointer to component location in message. More...

virtual char *	fomModuleNamesPtr ()

virtual const char *	fedExNamePtr () const
	Const version: Return pointer to component location in message. More...

virtual const char *	fomModuleNamesPtr () const

virtual DtFomModuleRequestMsg *	self () const

Protected Member Functions inherited from DtRtiMsg
	DtRtiMsg ()
	Constructor. More...

virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes. More...

void	initDtRtiMsg (int size, DtRtiMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual. More...

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. More...

virtual void	adjustBytes (void *address, int numBytes)
	Adjust the numBytes starting at the indicated addres. More...

Additional Inherited Members
Static Public Attributes inherited from DtRtiMsg
static unsigned long	theDefaultRegionSetHandle

static const DtRtiApiVariableLengthData	theDefaultTag

Protected Attributes inherited from DtRtiMsg
DtTransportHandle	myTransportType

DtOrderHandle	myOrderType

DtRtiApiTime *	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

static bool	theSmartForwardingEnabled

Detailed Description

Sent by Federates to request fed file from RtiExec.

Constructor & Destructor Documentation

DtFomModuleRequestMsg::DtFomModuleRequestMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Default / Send constructor.

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

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

Recv Constructor (from incoming message)

virtual DtFomModuleRequestMsg::~DtFomModuleRequestMsg ( )

virtual

Destructor.

Member Function Documentation

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

static

Add / Remove Callbacks.

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

virtual

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

Implements DtRtiMsg.

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

static

Creator for receiving.

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

static

Creator for sending.

unsigned long DtFomModuleRequestMsg::destinationID ( ) const

virtual char* DtFomModuleRequestMsg::fedExNamePtr ( )

protectedvirtual

Return pointer to component location in message.

virtual const char* DtFomModuleRequestMsg::fedExNamePtr ( ) const

protectedvirtual

Const version: Return pointer to component location in message.

virtual unsigned int DtFomModuleRequestMsg::fedExNameSize ( ) const

protectedvirtual

virtual char* DtFomModuleRequestMsg::fomModuleNamesPtr ( )

protectedvirtual

virtual const char* DtFomModuleRequestMsg::fomModuleNamesPtr ( ) const

protectedvirtual

virtual unsigned int DtFomModuleRequestMsg::fomModuleNamesSize ( ) const

protectedvirtual

virtual MAKRti::DtString DtFomModuleRequestMsg::fullFedExName ( ) const

virtual

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

virtual

virtual DtRtiMsgKind DtFomModuleRequestMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an Create Msg.

Implements DtRtiMsg.

virtual int DtFomModuleRequestMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

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

protectedvirtual

Return the buffer size needed for this message with the given variable data.

virtual const DtNetFomModuleReqMsg* DtFomModuleRequestMsg::netFomModuleReqMsg ( ) const

protectedvirtual

The network representation.

virtual DtNetFomModuleReqMsg* DtFomModuleRequestMsg::netFomModuleReqMsg ( )

protectedvirtual

virtual void DtFomModuleRequestMsg::printData ( DtLogicalTimeFactory * logicalTimeFactory ) const

virtual

Print the data section.

Reimplemented from DtRtiMsg.

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

static

DtFomModuleRequestMsg * DtFomModuleRequestMsg::self ( ) const

inlineprotectedvirtual

virtual void DtFomModuleRequestMsg::set	(	unsigned long	ID,
		unsigned long	destID,
		const MAKRti::DtString &	fedExNameVal,
		std::vector< MAKRti::DtString > const &	fomModuleName,
		bool	adjustBufferSize = `true`
	)

virtual

void DtFomModuleRequestMsg::setDestinationID ( unsigned long ID )

Set/Get Destination Federate ID.

virtual void DtFomModuleRequestMsg::setFedExNameSize ( unsigned long size )

protectedvirtual

Set/Get fedExNameSize.

virtual void DtFomModuleRequestMsg::setFomModuleNames	(	std::vector< MAKRti::DtString > const &	fomModuleName,
		bool	adjustBufferSize = `true`
	)

virtual

Set/Get Fom Module Name (adjust buffer size if not pre-allocated for this data).

virtual void DtFomModuleRequestMsg::setFomModuleNamesSize ( unsigned long size )

protectedvirtual

Set/Get fed fomModuleName size.

virtual void DtFomModuleRequestMsg::setFullFedExName	(	const MAKRti::DtString &	fedExNameVal,
		bool	adjustBufferSize = `true`
	)

virtual

Set/Get Federation Name (adjust buffer size if not pre-allocated for this data).

void DtFomModuleRequestMsg::setSourceID ( unsigned long ID )

Set/Get Source ID.

unsigned long DtFomModuleRequestMsg::sourceID ( ) const

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

fomModuleRequestMsg.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation