DtJoinLightWeightMsg Class Reference

Inheritance diagram for DtJoinLightWeightMsg:

Collaboration diagram for DtJoinLightWeightMsg:

Public Member Functions
	DtJoinLightWeightMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtJoinLightWeightMsg (MAKRti::DtString const &fedTypeValue, MAKRti::DtString const &fedExNameValue, MAKRti::DtString const &fedNameValue, MAKRti::DtString const &federateHostNameValue, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtJoinLightWeightMsg (const DtNetJoinLightWeightMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtJoinLightWeightMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (MAKRti::DtString const &fedTypeValue, MAKRti::DtString const &fedExNameValue, MAKRti::DtString const &fedNameValue, MAKRti::DtString const &federateHostNameValue)
	Set all fields simultaneously.
virtual void	setFederateType (MAKRti::DtString const &type)
	Set federate type.
virtual MAKRti::DtString	federateType () const
	Get federate type.
virtual void	setFullFedExName (MAKRti::DtString const &name)
	Set full name of federation execution.
virtual MAKRti::DtString	fullFedExName () const
	Get full name of federation execution.
virtual void	setFederateName (MAKRti::DtString const &name)
	Set federate name.
virtual MAKRti::DtString	federateName () const
	Get federate name.
virtual void	setFederateHostName (MAKRti::DtString const &name)
	Set fed host name.
virtual MAKRti::DtString	federateHostName () const
	Get fed host name.
virtual void	setIpAddress (const MAKRti::DtInetAddr &ip)
	Set federate IP address ( by default message will contain address of primary interface )
virtual MAKRti::DtInetAddr	ipAddress () const
	Get federate IP address.
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, DtJoinLightWeightCb cb, void *usr)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtJoinLightWeightCb 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 DtNetJoinLightWeightMsg *	netJoinLightWeightMsg ()
	The network representation.
virtual const DtNetJoinLightWeightMsg *	netJoinLightWeightMsg () 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)
	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	setFederateNameSize (unsigned long size)
	Set/Get fed name size.
virtual unsigned long	federateNameSize () const
virtual void	setFedExNameSize (unsigned long size)
	Set/Get fedEx name size.
virtual unsigned long	fedExNameSize () const
virtual void	setFederateHostNameSize (unsigned long size)
	Set Get size of federate host name.
virtual unsigned long	federateHostNameSize () const
virtual const char *	federateTypePtr () const
	Return pointer to component location in message.
virtual const char *	federateNamePtr () const
virtual const char *	fedExNamePtr () const
virtual const char *	federateHostNamePtr () const
virtual char *	federateTypePtr ()
virtual char *	federateNamePtr ()
virtual char *	fedExNamePtr ()
virtual char *	federateHostNamePtr ()
virtual DtJoinLightWeightMsg *	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 = 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

Constructor & Destructor Documentation

DtJoinLightWeightMsg::DtJoinLightWeightMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

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

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

DtJoinLightWeightMsg::DtJoinLightWeightMsg	(	MAKRti::DtString const &	fedTypeValue,
		MAKRti::DtString const &	fedExNameValue,
		MAKRti::DtString const &	fedNameValue,
		MAKRti::DtString const &	federateHostNameValue,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtDefaultInterfaceAddr(), DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), setFederateHostName(), setFederateName(), setFederateType(), setFullFedExName(), setIpAddress(), and setMinSizes().

DtJoinLightWeightMsg::DtJoinLightWeightMsg	(	const DtNetJoinLightWeightMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

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

DtJoinLightWeightMsg::~DtJoinLightWeightMsg ( )

virtual

Destructor.

Member Function Documentation

void DtJoinLightWeightMsg::addCallback ( DtConnectionMgr *  conn, DtJoinLightWeightCb  cb, void *  usr  )

static

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtJoinLightWeightMsgKind.

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

virtual

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

Implements DtRtiMsg.

References DtJoinLightWeightMsg(), and netJoinLightWeightMsg().

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

static

Creator.

References DtJoinLightWeightMsg().

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

static

Creator.

References DtJoinLightWeightMsg().

MAKRti::DtString DtJoinLightWeightMsg::federateHostName ( ) const

virtual

Get fed host name.

References federateHostNamePtr(), and federateHostNameSize().

Referenced by printData().

const char * DtJoinLightWeightMsg::federateHostNamePtr ( ) const

protectedvirtual

References federateNamePtr(), and federateNameSize().

Referenced by federateHostName(), federateTypePtr(), and setFederateHostName().

char * DtJoinLightWeightMsg::federateHostNamePtr ( )

protectedvirtual

References federateNamePtr(), and federateNameSize().

unsigned long DtJoinLightWeightMsg::federateHostNameSize ( ) const

protectedvirtual

References DtNetJoinLightWeightMsg::fedHostNameSize, and netJoinLightWeightMsg().

Referenced by federateHostName(), federateTypePtr(), and setFederateHostName().

MAKRti::DtString DtJoinLightWeightMsg::federateName ( ) const

virtual

Get federate name.

References federateNamePtr(), and federateNameSize().

Referenced by printData().

const char * DtJoinLightWeightMsg::federateNamePtr ( ) const

protectedvirtual

References fedExNamePtr(), and fedExNameSize().

Referenced by federateHostNamePtr(), federateName(), and setFederateName().

char * DtJoinLightWeightMsg::federateNamePtr ( )

protectedvirtual

References fedExNamePtr(), and fedExNameSize().

unsigned long DtJoinLightWeightMsg::federateNameSize ( ) const

protectedvirtual

References DtNetJoinLightWeightMsg::fedNameSize, and netJoinLightWeightMsg().

Referenced by federateHostNamePtr(), federateName(), and setFederateName().

MAKRti::DtString DtJoinLightWeightMsg::federateType ( ) const

virtual

Get federate type.

References federateTypePtr(), and federateTypeSize().

Referenced by printData().

const char * DtJoinLightWeightMsg::federateTypePtr ( ) const

protectedvirtual

Return pointer to component location in message.

References federateHostNamePtr(), and federateHostNameSize().

Referenced by federateType(), and setFederateType().

char * DtJoinLightWeightMsg::federateTypePtr ( )

protectedvirtual

References federateHostNamePtr(), and federateHostNameSize().

unsigned long DtJoinLightWeightMsg::federateTypeSize ( ) const

protectedvirtual

References DtNetJoinLightWeightMsg::fedTypeSize, and netJoinLightWeightMsg().

Referenced by federateType(), and setFederateType().

const char * DtJoinLightWeightMsg::fedExNamePtr ( ) const

protectedvirtual

References netJoinLightWeightMsg().

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

char * DtJoinLightWeightMsg::fedExNamePtr ( )

protectedvirtual

References netJoinLightWeightMsg().

unsigned long DtJoinLightWeightMsg::fedExNameSize ( ) const

protectedvirtual

References DtNetJoinLightWeightMsg::fedExNameSize, and netJoinLightWeightMsg().

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

MAKRti::DtString DtJoinLightWeightMsg::fullFedExName ( ) const

virtual

Get full name of federation execution.

References fedExNamePtr(), and fedExNameSize().

Referenced by printData().

DtRtiMsgKind DtJoinLightWeightMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an Join Msg.

Implements DtRtiMsg.

References DtJoinLightWeightMsgKind.

Referenced by DtJoinLightWeightMsg().

MAKRti::DtInetAddr DtJoinLightWeightMsg::ipAddress ( ) const

virtual

Get federate IP address.

References netJoinLightWeightMsg().

Referenced by printData().

int DtJoinLightWeightMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtJoinLightWeightMsg(), and set().

DtNetJoinLightWeightMsg * DtJoinLightWeightMsg::netJoinLightWeightMsg ( )

protectedvirtual

The network representation.

Referenced by clone(), federateHostNameSize(), federateNameSize(), federateTypeSize(), fedExNamePtr(), fedExNameSize(), ipAddress(), set(), setFederateHostNameSize(), setFederateNameSize(), setFederateTypeSize(), setFedExNameSize(), setFullFedExName(), and setIpAddress().

const DtNetJoinLightWeightMsg * DtJoinLightWeightMsg::netJoinLightWeightMsg ( ) const

protectedvirtual

void DtJoinLightWeightMsg::printData ( DtLogicalTimeFactory *  logicalTimeFactory ) const

virtual

Print the data section.

Reimplemented from DtRtiMsg.

References federateHostName(), federateName(), federateType(), fullFedExName(), and ipAddress().

void DtJoinLightWeightMsg::removeCallback ( DtConnectionMgr *  conn, DtJoinLightWeightCb  cb, void *  usr  )

static

References DtJoinLightWeightMsgKind, and DtConnectionMgr::removeMsgCallback().

DtJoinLightWeightMsg * DtJoinLightWeightMsg::self ( ) const

inlineprotectedvirtual

Casts away const-ness.

void DtJoinLightWeightMsg::set ( MAKRti::DtString const &  fedTypeValue, MAKRti::DtString const &  fedExNameValue, MAKRti::DtString const &  fedNameValue, MAKRti::DtString const &  federateHostNameValue  )

virtual

Set all fields simultaneously.

References DtDefaultInterfaceAddr(), rti1516e::insertBytes(), minSize(), netJoinLightWeightMsg(), setFederateHostName(), setFederateName(), setFederateType(), setFullFedExName(), setIpAddress(), and setMinSizes().

Referenced by DtPartnerMgr::sendJoinMessage().

void DtJoinLightWeightMsg::setFederateHostName ( MAKRti::DtString const &  name )

virtual

Set fed host name.

References federateHostNamePtr(), federateHostNameSize(), rti1516e::insertBytes(), and setFederateHostNameSize().

Referenced by DtJoinLightWeightMsg(), and set().

void DtJoinLightWeightMsg::setFederateHostNameSize ( unsigned long  size )

protectedvirtual

Set Get size of federate host name.

References DtNetJoinLightWeightMsg::fedHostNameSize, and netJoinLightWeightMsg().

Referenced by setFederateHostName(), and setMinSizes().

void DtJoinLightWeightMsg::setFederateName ( MAKRti::DtString const &  name )

virtual

Set federate name.

References federateNamePtr(), federateNameSize(), rti1516e::insertBytes(), and setFederateNameSize().

Referenced by DtJoinLightWeightMsg(), and set().

void DtJoinLightWeightMsg::setFederateNameSize ( unsigned long  size )

protectedvirtual

Set/Get fed name size.

References DtNetJoinLightWeightMsg::fedNameSize, and netJoinLightWeightMsg().

Referenced by setFederateName(), and setMinSizes().

void DtJoinLightWeightMsg::setFederateType ( MAKRti::DtString const &  type )

virtual

Set federate type.

References federateTypePtr(), federateTypeSize(), rti1516e::insertBytes(), and setFederateTypeSize().

Referenced by DtJoinLightWeightMsg(), and set().

void DtJoinLightWeightMsg::setFederateTypeSize ( unsigned long  size )

protectedvirtual

Set/Get fed type size.

References DtNetJoinLightWeightMsg::fedTypeSize, and netJoinLightWeightMsg().

Referenced by setFederateType(), and setMinSizes().

void DtJoinLightWeightMsg::setFedExNameSize ( unsigned long  size )

protectedvirtual

Set/Get fedEx name size.

References DtNetJoinLightWeightMsg::fedExNameSize, and netJoinLightWeightMsg().

Referenced by setMinSizes().

void DtJoinLightWeightMsg::setFullFedExName ( MAKRti::DtString const &  name )

virtual

Set full name of federation execution.

References fedExNamePtr(), DtNetJoinLightWeightMsg::fedExNameSize, fedExNameSize(), rti1516e::insertBytes(), and netJoinLightWeightMsg().

Referenced by DtJoinLightWeightMsg(), and set().

void DtJoinLightWeightMsg::setIpAddress ( const MAKRti::DtInetAddr &  ip )

virtual

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

References DtNetJoinLightWeightMsg::inetAddrFamily, netJoinLightWeightMsg(), and DtNetJoinLightWeightMsg::sourceIP.

Referenced by DtJoinLightWeightMsg(), DtPartnerMgr::sendJoinMessage(), and set().

int DtJoinLightWeightMsg::setMinSizes ( MAKRti::DtString const &  federateType, MAKRti::DtString const &  fedExName, MAKRti::DtString const &  federateName, MAKRti::DtString const &  federateHostName  )

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 DtJoinLightWeightMsg(), setFederateHostNameSize(), setFederateNameSize(), setFederateTypeSize(), and setFedExNameSize().

Referenced by DtJoinLightWeightMsg(), and set().

---

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

• joinLightWeightMsg.h
• joinLightWeightMsg.cxx