DtJoinMsg Class Reference

Inheritance diagram for DtJoinMsg:

Collaboration diagram for DtJoinMsg:

Public Member Functions
	DtJoinMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtJoinMsg (unsigned long sourceIDValue, unsigned short requestIDValue, MAKRti::DtString const &fedTypeValue, MAKRti::DtString const &fedExNameValue, MAKRti::DtString const &fedNameValue, MAKRti::DtString const &federateHostNameValue, const std::vector< MAKRti::DtString > &moduleNames, DtHlaVersionId hlaVersion, int astntCompId, unsigned long flagsValue, unsigned int needPartnerValue, const std::vector< unsigned int > &joinModulesCrcs, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtJoinMsg (const DtNetJoinMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtJoinMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (unsigned long sourceIDValue, unsigned short requestIDValue, MAKRti::DtString const &fedTypeValue, MAKRti::DtString const &fedExNameValue, MAKRti::DtString const &fedNameValue, MAKRti::DtString const &federateHostNameValue, const std::vector< MAKRti::DtString > &moduleNames, DtHlaVersionId hlaVersion, int astntCompId, unsigned long flagsValue, unsigned int needPartnerValue, const std::vector< unsigned int > &joinModulesCrcs)
	Set all fields simultaneously.
virtual unsigned long	sourceID () const
	Set/Get federate destination ID The federate name is not enough to uniquely identify it among other federates.
virtual void	setSourceID (unsigned long sourceIDValue)
virtual unsigned short	requestID () const
	Set/Get request ID.
virtual void	setRequestID (unsigned short requestIDValue)
virtual void	setFederateType (MAKRti::DtString const &type)
	Set/Get federate type.
virtual MAKRti::DtString	federateType () const
virtual void	setFullFedExName (MAKRti::DtString const &name)
	Set/Get full name of federation execution.
virtual MAKRti::DtString	fullFedExName () const
virtual void	setFederateName (MAKRti::DtString const &name)
	Set/Get federate name.
virtual MAKRti::DtString	federateName () const
virtual void	setFederateHostName (MAKRti::DtString const &name)
	Set / Get fed host name.
virtual MAKRti::DtString	federateHostName () const
virtual void	setFomModuleNames (const std::vector< MAKRti::DtString > &moduleNames)
	Set/Get Fom Module Names.
virtual void	getFomModuleNames (std::vector< MAKRti::DtString > &modules) const
virtual void	setIpAddress (const MAKRti::DtInetAddr &ip)
	Set/Get federate IP address ( by default message will contain address of primary interface )
virtual MAKRti::DtInetAddr	ipAddress () const
virtual void	setHlaVersion (DtHlaVersionId version)
	Set/Get the HLA version of the federate.
virtual DtHlaVersionId	hlaVersion () const
virtual void	setAssistantCompId (int id)
	Set/Get the Assistant component ID federate.
virtual int	assistantCompId () const
virtual void	setFlags (unsigned long value)
	Set/Get flags.
virtual unsigned long	flags () const
virtual void	setNeedPartner (unsigned int value)
	Set/Get need partner indicator.
virtual unsigned int	needPartner () const
unsigned int	numOfCrcs () const
	Set/Get number of CRCs.
void	setNumOfCrcs (unsigned int value)
virtual void	setCrcsOfFedFiles (const std::vector< unsigned int > &moduleCrcs)
	Set/Get CRCs of 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.
static DtRtiMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creator.
static void	addCallback (DtConnectionMgr *conn, DtJoinCb cb, void *usr)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtJoinCb 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 DtNetJoinMsg *	netJoinMsg ()
	The network representation.
virtual const DtNetJoinMsg *	netJoinMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Join Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual int	setMinSizes (MAKRti::DtString const &federateType, MAKRti::DtString const &fedExName, MAKRti::DtString const &federateName, MAKRti::DtString const &federateHostName, const std::vector< MAKRti::DtString > &fomModuleNamesVal, const std::vector< unsigned int > &joinModulesCrcs)
	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	setFederateTypeSize (unsigned long size)
	Set/Get fed type size.
virtual unsigned long	federateTypeSize () const
virtual void	setFedExNameSize (unsigned long size)
	Set/Get fedEx name size.
virtual unsigned long	fedExNameSize () const
virtual void	setFederateNameSize (unsigned long size)
	Set/Get fed name size.
virtual unsigned long	federateNameSize () const
virtual void	setFederateHostNameSize (unsigned long size)
	Set Get size of federate host name.
virtual unsigned long	federateHostNameSize () const
virtual void	setfomModuleNameSize (unsigned long size)
	Set/Get fomModules Names Size.
virtual unsigned long	fomModuleNameSize () const
virtual const char *	federateNamePtr () const
	Return pointer to component location in message.
virtual const char *	fedExNamePtr () const
virtual const char *	federateTypePtr () const
virtual const char *	fomModuleNamesPtr () const
virtual const char *	federateHostNamePtr () const
virtual const DtNetU32 *	crcsOfFomModulesPtr () const
virtual char *	federateNamePtr ()
virtual char *	fedExNamePtr ()
virtual char *	federateTypePtr ()
virtual char *	fomModuleNamesPtr ()
virtual char *	federateHostNamePtr ()
virtual DtNetU32 *	crcsOfFomModulesPtr ()
virtual DtJoinMsg *	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

DtJoinMsg::DtJoinMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

DtJoinMsg::DtJoinMsg	(	unsigned long	sourceIDValue,
		unsigned short	requestIDValue,
		MAKRti::DtString const &	fedTypeValue,
		MAKRti::DtString const &	fedExNameValue,
		MAKRti::DtString const &	fedNameValue,
		MAKRti::DtString const &	federateHostNameValue,
		const std::vector< MAKRti::DtString > &	moduleNames,
		DtHlaVersionId	hlaVersion,
		int	astntCompId,
		unsigned long	flagsValue,
		unsigned int	needPartnerValue,
		const std::vector< unsigned int > &	joinModulesCrcs,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtJoinMsg::DtJoinMsg	(	const DtNetJoinMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

virtual DtJoinMsg::~DtJoinMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtJoinMsg::addCallback ( DtConnectionMgr *  conn, DtJoinCb  cb, void *  usr  )

static

Callback management.

virtual int DtJoinMsg::assistantCompId ( ) const

virtual

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

virtual

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

Implements DtRtiMsg.

virtual const DtNetU32* DtJoinMsg::crcsOfFomModulesPtr ( ) const

protectedvirtual

virtual DtNetU32* DtJoinMsg::crcsOfFomModulesPtr ( )

protectedvirtual

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

static

Creator.

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

static

Creator.

virtual MAKRti::DtString DtJoinMsg::federateHostName ( ) const

virtual

virtual const char* DtJoinMsg::federateHostNamePtr ( ) const

protectedvirtual

virtual char* DtJoinMsg::federateHostNamePtr ( )

protectedvirtual

virtual unsigned long DtJoinMsg::federateHostNameSize ( ) const

protectedvirtual

virtual MAKRti::DtString DtJoinMsg::federateName ( ) const

virtual

virtual const char* DtJoinMsg::federateNamePtr ( ) const

protectedvirtual

Return pointer to component location in message.

virtual char* DtJoinMsg::federateNamePtr ( )

protectedvirtual

virtual unsigned long DtJoinMsg::federateNameSize ( ) const

protectedvirtual

virtual MAKRti::DtString DtJoinMsg::federateType ( ) const

virtual

virtual const char* DtJoinMsg::federateTypePtr ( ) const

protectedvirtual

virtual char* DtJoinMsg::federateTypePtr ( )

protectedvirtual

virtual unsigned long DtJoinMsg::federateTypeSize ( ) const

protectedvirtual

virtual const char* DtJoinMsg::fedExNamePtr ( ) const

protectedvirtual

virtual char* DtJoinMsg::fedExNamePtr ( )

protectedvirtual

virtual unsigned long DtJoinMsg::fedExNameSize ( ) const

protectedvirtual

virtual unsigned long DtJoinMsg::flags ( ) const

virtual

virtual unsigned long DtJoinMsg::fomModuleNameSize ( ) const

protectedvirtual

virtual const char* DtJoinMsg::fomModuleNamesPtr ( ) const

protectedvirtual

virtual char* DtJoinMsg::fomModuleNamesPtr ( )

protectedvirtual

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

virtual

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

virtual

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

virtual

virtual DtHlaVersionId DtJoinMsg::hlaVersion ( ) const

virtual

virtual DtRtiMsgKind DtJoinMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an Join Msg.

Implements DtRtiMsg.

virtual MAKRti::DtInetAddr DtJoinMsg::ipAddress ( ) const

virtual

virtual int DtJoinMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual unsigned int DtJoinMsg::needPartner ( ) const

virtual

virtual DtNetJoinMsg* DtJoinMsg::netJoinMsg ( )

protectedvirtual

The network representation.

virtual const DtNetJoinMsg* DtJoinMsg::netJoinMsg ( ) const

protectedvirtual

unsigned int DtJoinMsg::numOfCrcs

(

)

const

Set/Get number of CRCs.

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

virtual

Print the data section.

Reimplemented from DtRtiMsg.

static void DtJoinMsg::removeCallback ( DtConnectionMgr *  conn, DtJoinCb  cb, void *  usr  )

static

virtual unsigned short DtJoinMsg::requestID ( ) const

virtual

Set/Get request ID.

DtJoinMsg * DtJoinMsg::self ( ) const

inlineprotectedvirtual

Casts away const-ness.

virtual void DtJoinMsg::set ( unsigned long  sourceIDValue, unsigned short  requestIDValue, MAKRti::DtString const &  fedTypeValue, MAKRti::DtString const &  fedExNameValue, MAKRti::DtString const &  fedNameValue, MAKRti::DtString const &  federateHostNameValue, const std::vector< MAKRti::DtString > &  moduleNames, DtHlaVersionId  hlaVersion, int  astntCompId, unsigned long  flagsValue, unsigned int  needPartnerValue, const std::vector< unsigned int > &  joinModulesCrcs  )

virtual

Set all fields simultaneously.

virtual void DtJoinMsg::setAssistantCompId ( int  id )

virtual

Set/Get the Assistant component ID federate.

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

virtual

Set/Get CRCs of Fed Files.

virtual void DtJoinMsg::setFederateHostName ( MAKRti::DtString const &  name )

virtual

Set / Get fed host name.

virtual void DtJoinMsg::setFederateHostNameSize ( unsigned long  size )

protectedvirtual

Set Get size of federate host name.

virtual void DtJoinMsg::setFederateName ( MAKRti::DtString const &  name )

virtual

Set/Get federate name.

virtual void DtJoinMsg::setFederateNameSize ( unsigned long  size )

protectedvirtual

Set/Get fed name size.

virtual void DtJoinMsg::setFederateType ( MAKRti::DtString const &  type )

virtual

Set/Get federate type.

virtual void DtJoinMsg::setFederateTypeSize ( unsigned long  size )

protectedvirtual

Set/Get fed type size.

virtual void DtJoinMsg::setFedExNameSize ( unsigned long  size )

protectedvirtual

Set/Get fedEx name size.

virtual void DtJoinMsg::setFlags ( unsigned long  value )

virtual

Set/Get flags.

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

virtual

Set/Get Fom Module Names.

virtual void DtJoinMsg::setfomModuleNameSize ( unsigned long  size )

protectedvirtual

Set/Get fomModules Names Size.

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

virtual

Set/Get full name of federation execution.

virtual void DtJoinMsg::setHlaVersion ( DtHlaVersionId  version )

virtual

Set/Get the HLA version of the federate.

virtual void DtJoinMsg::setIpAddress ( const MAKRti::DtInetAddr &  ip )

virtual

Set/Get federate IP address ( by default message will contain address of primary interface )

virtual int DtJoinMsg::setMinSizes ( MAKRti::DtString const &  federateType, MAKRti::DtString const &  fedExName, MAKRti::DtString const &  federateName, MAKRti::DtString const &  federateHostName, const std::vector< MAKRti::DtString > &  fomModuleNamesVal, const std::vector< unsigned int > &  joinModulesCrcs  )

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.

virtual void DtJoinMsg::setNeedPartner ( unsigned int  value )

virtual

Set/Get need partner indicator.

void DtJoinMsg::setNumOfCrcs

(

unsigned int

value

)

virtual void DtJoinMsg::setRequestID ( unsigned short  requestIDValue )

virtual

virtual void DtJoinMsg::setSourceID ( unsigned long  sourceIDValue )

virtual

virtual unsigned long DtJoinMsg::sourceID ( ) const

virtual

Set/Get federate destination ID The federate name is not enough to uniquely identify it among other federates.

This source ID should uniquely identify the federate (at least in conjunction with name).

---

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

• joinMsg.h