DtCreateMsg Class Reference

Inheritance diagram for DtCreateMsg:

Collaboration diagram for DtCreateMsg:

Public Member Functions
	DtCreateMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtCreateMsg (unsigned long ID, const MAKRti::DtString &fedExNameVal, const std::vector< unsigned int > &moduleCrcs, MAKRti::DtFomType fedType, const std::vector< MAKRti::DtString > &moduleNames, const MAKRti::DtString &momModule, const MAKRti::DtString &timeImplNameVal=MAKRti::DtString::nullString(), DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtCreateMsg (const DtNetCreateMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtCreateMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (unsigned long ID, unsigned int momModuleCrc, const MAKRti::DtString &fedExNameVal, const std::vector< unsigned int > &moduleCrcs, MAKRti::DtFomType fedType, const std::vector< MAKRti::DtString > &moduleNames, const MAKRti::DtString &momModule, const MAKRti::DtString &timeImplNameVal)
	Set all fields in this msg.
void	setSourceID (const unsigned long ID)
	Set/Get Source ID.
unsigned long	sourceID () const
void	setMomModuleCrc (unsigned int theMomModuleCrc)
	Set/Get MOM Module CRC.
unsigned int	momModuleCrc () const
virtual void	setFullFedExName (const MAKRti::DtString &name)
	Set/Get full name of federation execution.
virtual const MAKRti::DtString	fullFedExName () const
virtual void	setTimeImplName (const MAKRti::DtString &name)
	Set/Get TimeImplName.
virtual MAKRti::DtString	timeImplName () const
virtual void	setFomModuleNames (const std::vector< MAKRti::DtString > &moduleNames)
	Set/Get FedFileName.
virtual void	getFomModuleNames (std::vector< MAKRti::DtString > &modules) const
virtual void	setFedFileType (MAKRti::DtFomType fedType)
	Set/Get FED file type.
virtual MAKRti::DtFomType	fedFileType () const
virtual bool	hasMOMModule ()
	Whether there is a MOM module for this federation.
virtual void	setMOMModuleName (const MAKRti::DtString &name)
	Set / Get momModuleName.
virtual MAKRti::DtString	MOMmoduleName () const
virtual void	setCrcsOfFedFiles (const std::vector< unsigned int > &moduleCrcs)
	Set/ Get a hashes (crcs) of the fed files.
virtual void	getCRCsOfFedFiles (std::vector< unsigned int > &crcOfFedFiles) 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, DtCreateCb cb, void *usr)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtCreateCb 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 unsigned long	totalSize (const void *buffer)
	Extracts the message total size form the given buffer.
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 unsigned char	flags (const void *buffer)
	Extracts the message flags form the given buffer.
static unsigned long	metadataSize (const void *buffer)
	Extracts the message metadata size 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 DtNetCreateMsg *	netCreateMsg ()
	The network representation.
virtual const DtNetCreateMsg *	netCreateMsg () const
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, const MAKRti::DtString &timeImplNameVal, const MAKRti::DtString &momModuleNameVal, const std::vector< MAKRti::DtString > &fomModuleNamesVal, const std::vector< unsigned int > &moduleCrcs)
	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 fedEx name size.
virtual unsigned long	fedExNameSize () const
virtual void	setTimeImplNameSize (unsigned long size)
	Set/Get time implementation name size.
virtual unsigned long	timeImplNameSize () const
virtual void	setFomModuleNameSize (unsigned long size)
	Set/Get fomModules Names size.
virtual unsigned long	fomModuleNameSize () const
virtual void	setSizeOfMOMModuleName (unsigned long size)
virtual unsigned long	sizeOfMOMModuleName () const
virtual void	setNumOfCrcs (unsigned int theNumOfCrcs)
virtual unsigned long	numOfCrcs () const
virtual const char *	fedExNamePtr () const
	Return pointer to component location in message.
virtual const char *	timeImplNamePtr () const
virtual const char *	fomModuleNamesPtr () const
virtual const char *	momModuleNamePtr () const
virtual const DtNetU32 *	crcsOfFomModulesPtr () const
virtual char *	fedExNamePtr ()
	Return pointer to component location in message.
virtual char *	timeImplNamePtr ()
virtual char *	fomModuleNamesPtr ()
virtual char *	momModuleNamePtr ()
virtual DtNetU32 *	crcsOfFomModulesPtr ()
virtual DtCreateMsg *	self () const
	Casts away const-ness.
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
static const char *	theDefaultTag
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
static bool	theSmartForwardingEnabled

Constructor & Destructor Documentation

DtCreateMsg::DtCreateMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

DtCreateMsg::DtCreateMsg	(	unsigned long	ID,
		const MAKRti::DtString &	fedExNameVal,
		const std::vector< unsigned int > &	moduleCrcs,
		MAKRti::DtFomType	fedType,
		const std::vector< MAKRti::DtString > &	moduleNames,
		const MAKRti::DtString &	momModule,
		const MAKRti::DtString &	timeImplNameVal = MAKRti::DtString::nullString(),
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtCreateMsg::DtCreateMsg	(	const DtNetCreateMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

virtual DtCreateMsg::~DtCreateMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtCreateMsg::addCallback ( DtConnectionMgr *  conn, DtCreateCb  cb, void *  usr  )

static

Callback management.

virtual DtRtiMsg* DtCreateMsg::clone ( bool  copy = true ) const

virtual

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

Implements DtRtiMsg.

virtual const DtNetU32* DtCreateMsg::crcsOfFomModulesPtr ( ) const

protectedvirtual

virtual DtNetU32* DtCreateMsg::crcsOfFomModulesPtr ( )

protectedvirtual

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

static

Creator for receiving.

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

static

Creator for sending.

virtual const char* DtCreateMsg::fedExNamePtr ( ) const

protectedvirtual

Return pointer to component location in message.

virtual char* DtCreateMsg::fedExNamePtr ( )

protectedvirtual

Return pointer to component location in message.

virtual unsigned long DtCreateMsg::fedExNameSize ( ) const

protectedvirtual

virtual MAKRti::DtFomType DtCreateMsg::fedFileType ( ) const

virtual

virtual unsigned long DtCreateMsg::fomModuleNameSize ( ) const

protectedvirtual

virtual const char* DtCreateMsg::fomModuleNamesPtr ( ) const

protectedvirtual

virtual char* DtCreateMsg::fomModuleNamesPtr ( )

protectedvirtual

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

virtual

virtual void DtCreateMsg::getCRCsOfFedFiles ( std::vector< unsigned int > &  crcOfFedFiles ) const

virtual

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

virtual

virtual bool DtCreateMsg::hasMOMModule ( )

virtual

Whether there is a MOM module for this federation.

virtual DtRtiMsgKind DtCreateMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an Create Msg.

Implements DtRtiMsg.

virtual int DtCreateMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

unsigned int DtCreateMsg::momModuleCrc

(

)

const

virtual MAKRti::DtString DtCreateMsg::MOMmoduleName ( ) const

virtual

virtual const char* DtCreateMsg::momModuleNamePtr ( ) const

protectedvirtual

virtual char* DtCreateMsg::momModuleNamePtr ( )

protectedvirtual

virtual DtNetCreateMsg* DtCreateMsg::netCreateMsg ( )

protectedvirtual

The network representation.

virtual const DtNetCreateMsg* DtCreateMsg::netCreateMsg ( ) const

protectedvirtual

virtual unsigned long DtCreateMsg::numOfCrcs ( ) const

protectedvirtual

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

virtual

Print the data section.

Reimplemented from DtRtiMsg.

static void DtCreateMsg::removeCallback ( DtConnectionMgr *  conn, DtCreateCb  cb, void *  usr  )

static

DtCreateMsg * DtCreateMsg::self ( ) const

inlineprotectedvirtual

Casts away const-ness.

virtual void DtCreateMsg::set ( unsigned long  ID, unsigned int  momModuleCrc, const MAKRti::DtString &  fedExNameVal, const std::vector< unsigned int > &  moduleCrcs, MAKRti::DtFomType  fedType, const std::vector< MAKRti::DtString > &  moduleNames, const MAKRti::DtString &  momModule, const MAKRti::DtString &  timeImplNameVal  )

virtual

Set all fields in this msg.

virtual void DtCreateMsg::setCrcsOfFedFiles ( const std::vector< unsigned int > &  moduleCrcs )

virtual

Set/ Get a hashes (crcs) of the fed files.

virtual void DtCreateMsg::setFedExNameSize ( unsigned long  size )

protectedvirtual

Set/Get fedEx name size.

virtual void DtCreateMsg::setFedFileType ( MAKRti::DtFomType  fedType )

virtual

Set/Get FED file type.

virtual void DtCreateMsg::setFomModuleNames ( const std::vector< MAKRti::DtString > &  moduleNames )

virtual

Set/Get FedFileName.

virtual void DtCreateMsg::setFomModuleNameSize ( unsigned long  size )

protectedvirtual

Set/Get fomModules Names size.

virtual void DtCreateMsg::setFullFedExName ( const MAKRti::DtString &  name )

virtual

Set/Get full name of federation execution.

virtual int DtCreateMsg::setMinSizes ( const MAKRti::DtString &  fedExNameVal, const MAKRti::DtString &  timeImplNameVal, const MAKRti::DtString &  momModuleNameVal, const std::vector< MAKRti::DtString > &  fomModuleNamesVal, const std::vector< unsigned int > &  moduleCrcs  )

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.

void DtCreateMsg::setMomModuleCrc

(

unsigned int

theMomModuleCrc

)

Set/Get MOM Module CRC.

virtual void DtCreateMsg::setMOMModuleName ( const MAKRti::DtString &  name )

virtual

Set / Get momModuleName.

virtual void DtCreateMsg::setNumOfCrcs ( unsigned int  theNumOfCrcs )

protectedvirtual

virtual void DtCreateMsg::setSizeOfMOMModuleName ( unsigned long  size )

protectedvirtual

void DtCreateMsg::setSourceID

(

const unsigned long

ID

)

Set/Get Source ID.

virtual void DtCreateMsg::setTimeImplName ( const MAKRti::DtString &  name )

virtual

Set/Get TimeImplName.

virtual void DtCreateMsg::setTimeImplNameSize ( unsigned long  size )

protectedvirtual

Set/Get time implementation name size.

virtual unsigned long DtCreateMsg::sizeOfMOMModuleName ( ) const

protectedvirtual

unsigned long DtCreateMsg::sourceID

(

)

const

virtual MAKRti::DtString DtCreateMsg::timeImplName ( ) const

virtual

virtual const char* DtCreateMsg::timeImplNamePtr ( ) const

protectedvirtual

virtual char* DtCreateMsg::timeImplNamePtr ( )

protectedvirtual

virtual unsigned long DtCreateMsg::timeImplNameSize ( ) const

protectedvirtual

---

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

• createMsg.h