DtJoinLightWeightMsg Class Reference

Inheritance diagram for DtJoinLightWeightMsg:

Collaboration diagram for DtJoinLightWeightMsg:

List of all members.

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

---

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 [protected, virtual]

References federateNamePtr(), and federateNameSize().

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

char * DtJoinLightWeightMsg::federateHostNamePtr

(

)

[protected, virtual]

References federateNamePtr(), and federateNameSize().

unsigned long DtJoinLightWeightMsg::federateHostNameSize

(

)

const [protected, virtual]

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 [protected, virtual]

References fedExNamePtr(), and fedExNameSize().

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

char * DtJoinLightWeightMsg::federateNamePtr

(

)

[protected, virtual]

References fedExNamePtr(), and fedExNameSize().

unsigned long DtJoinLightWeightMsg::federateNameSize

(

)

const [protected, virtual]

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 [protected, virtual]

Return pointer to component location in message.

References federateHostNamePtr(), and federateHostNameSize().

Referenced by federateType(), and setFederateType().

char * DtJoinLightWeightMsg::federateTypePtr

(

)

[protected, virtual]

References federateHostNamePtr(), and federateHostNameSize().

unsigned long DtJoinLightWeightMsg::federateTypeSize

(

)

const [protected, virtual]

References DtNetJoinLightWeightMsg::fedTypeSize, and netJoinLightWeightMsg().

Referenced by federateType(), and setFederateType().

const char * DtJoinLightWeightMsg::fedExNamePtr

(

)

const [protected, virtual]

References netJoinLightWeightMsg().

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

char * DtJoinLightWeightMsg::fedExNamePtr

(

)

[protected, virtual]

References netJoinLightWeightMsg().

unsigned long DtJoinLightWeightMsg::fedExNameSize

(

)

const [protected, virtual]

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

(

)

[protected, virtual]

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 [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtJoinLightWeightMsg(), and set().

DtNetJoinLightWeightMsg * DtJoinLightWeightMsg::netJoinLightWeightMsg

(

)

[protected, virtual]

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 [protected, virtual]

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 [inline, protected, virtual]

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

)

[protected, virtual]

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

)

[protected, virtual]

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

)

[protected, virtual]

Set/Get fed type size.

References DtNetJoinLightWeightMsg::fedTypeSize, and netJoinLightWeightMsg().

Referenced by setFederateType(), and setMinSizes().

void DtJoinLightWeightMsg::setFedExNameSize

(

unsigned long

size

)

[protected, virtual]

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
	)		[protected, virtual]

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