The DtAssistantRidParamsMsg defines a wrapper for the RTI Assistant RID parameter message used by the Assistant to request RID parameters and by an rtiexec to respond with its RID parameters. More...

Inheritance diagram for DtAssistantRidParamsMsg:

Collaboration diagram for DtAssistantRidParamsMsg:

Public Member Functions
	DtAssistantRidParamsMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Default / Send constructor.
	DtAssistantRidParamsMsg (const DtNetAssistantRidParamsMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Recv Constructor (from incoming message)
virtual	~DtAssistantRidParamsMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual int	minSize () const
virtual void	setIsRequest (bool isReq)
	Set whether this is a request message, otherwise its a response msg.
virtual bool	isRequest () const
	Get whether this is a request message, otherwise its a response msg.
virtual void	setFederateHandle (unsigned hdl)
	Set whether this is a request message, otherwise its a response msg.
virtual unsigned	federateHandle () const
	Get whether this is a request message, otherwise its a response msg.
virtual void	setRidFilename (const MAKRti::DtFilename &filename)
	Set RID filename.
virtual MAKRti::DtFilename	ridFilename () const
	Get RID filename.
virtual void	setRidParams (const MAKRti::DtString &ridParams)
	Set RID parameters.
virtual void	getRidParams (MAKRti::DtString &ridParams) const
	Get RID parameters.
virtual void	setFederation (const MAKRti::DtString &federation)
	Set RID filename.
virtual MAKRti::DtString	federation () const
	Get RID filename.
virtual void	printData () const
	Print the data section.
Public Member Functions inherited from DtAssistantMsg
virtual	~DtAssistantMsg ()
	Destructor.
virtual DtNetAssistantMsgHeader *	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 DtAssistantMsgKind	msgKind () const
	Get the message kind.
virtual void	print () const
	Printing functions.
virtual void	printHeader () const
virtual bool	isOk () const
	Message is good?
bool	isAssistantToAssistantMessage () const
	Returns whether or not this message contains source/destination information included in messages sent between assistants.
virtual MAKRti::DtInetAddr	sourceAddr () const
	Get/Set the IP address of the source of this message.
virtual void	setSourceAddr (const MAKRti::DtInetAddr &addr)
virtual int	sourceId () const
	Get/Set the ID of the source of this message.
virtual void	setSourceId (int id)
virtual MAKRti::DtString	sourceHost () const
	Get/Set the host name of the source of this message.
virtual void	setSourceHost (const MAKRti::DtString &addr)
virtual MAKRti::DtInetAddr	destAddr () const
	Get/Set the IP address of the destination of this message.
virtual void	setDestAddr (const MAKRti::DtInetAddr &addr)
virtual int	destId () const
	Get/Set the ID of the destination of this message.
virtual void	setDestId (int id)
virtual int	compId () const
	Get/Set the related component's connection ID.
virtual void	setCompId (int compId)

Static Public Member Functions
static DtAssistantMsg *	create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creator for receiving.
static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creator for sending.
Callback management
static void	addCallback (DtRtiAssistantClient conn, DtAssistantRidParamsCb cb, void usr)
static void	removeCallback (DtRtiAssistantClient conn, DtAssistantRidParamsCb cb, void usr)
static void	addCallback (DtRtiAssistantServer conn, DtAssistantRidParamsCb cb, void usr)
static void	removeCallback (DtRtiAssistantServer conn, DtAssistantRidParamsCb cb, void usr)
static void	addCallback (DtRtiAssistantPeer conn, DtAssistantRidParamsCb cb, void usr)
static void	removeCallback (DtRtiAssistantPeer conn, DtAssistantRidParamsCb cb, void usr)
Static Public Member Functions inherited from DtAssistantMsg
static const char *	kindToString (DtAssistantMsgKind kind)
	Returns the name of the message, by kind enumeration.

Protected Member Functions
virtual DtNetAssistantRidParamsMsg *	netAssistantRidParamsMsg ()
	The network representation.
virtual const DtNetAssistantRidParamsMsg *	netAssistantRidParamsMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of this message.
virtual void	setRidFilenameSize (unsigned long size)
	Set/Get RID filename size.
virtual unsigned long	ridFilenameSize () const
virtual const char *	ridFilenamePtr () const
	Return pointer to RID filename name location in message.
virtual char *	ridFilenamePtr ()
virtual void	setRidParametersSize (unsigned long size)
	Set/Get RID parameters size.
virtual unsigned long	ridParametersSize () const
virtual const char *	ridParametersPtr () const
	Return pointer to RID parameters location in message.
virtual char *	ridParametersPtr ()
virtual void	setFederationSize (unsigned long size)
	Set/Get federation name size.
virtual unsigned long	federationSize () const
virtual const char *	federationPtr () const
	Return pointer to RID parameters location in message.
virtual char *	federationPtr ()
Protected Member Functions inherited from DtAssistantMsg
	DtAssistantMsg ()
	Constructor.
virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes.
void	initAssistantMsg (int size, DtAssistantMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual.
void	initAssistantMsg (const void *initial, int size, DtBufferPtr buffer)
void	initAssistantMsg (const DtNetAssistantMsgHeader *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 address.
virtual void	resizeForSrcDestInfo ()
	Allocates memory at the end of the message for source/destination information needed when sending messages between assistants.
virtual const DtNetAssistantSrcDestInfo *	srcDestInfoPtr () const
	Return pointer to source/destination information in the message.
virtual DtNetAssistantSrcDestInfo *	srcDestInfoPtr ()
virtual void	setSourceHostSize (unsigned long size)
	Set/Get source host name text size.
virtual unsigned long	sourceHostSize () const
virtual const char *	sourceHostPtr () const
	Return pointer to source host name in message.
virtual char *	sourceHostPtr ()

Detailed Description

The DtAssistantRidParamsMsg defines a wrapper for the RTI Assistant RID parameter message used by the Assistant to request RID parameters and by an rtiexec to respond with its RID parameters.

Constructor & Destructor Documentation

DtAssistantRidParamsMsg::DtAssistantRidParamsMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Default / Send constructor.

DtAssistantRidParamsMsg::DtAssistantRidParamsMsg	(	const DtNetAssistantRidParamsMsg *	netRepMsg,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

Recv Constructor (from incoming message)

virtual DtAssistantRidParamsMsg::~DtAssistantRidParamsMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtAssistantRidParamsMsg::addCallback	(	DtRtiAssistantClient *	conn,
		DtAssistantRidParamsCb	cb,
		void *	usr
	)

static

static void DtAssistantRidParamsMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantRidParamsCb	cb,
		void *	usr
	)

static

static void DtAssistantRidParamsMsg::addCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantRidParamsCb	cb,
		void *	usr
	)

static

virtual DtAssistantMsg* DtAssistantRidParamsMsg::clone ( bool copy = true ) const

virtual

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

Implements DtAssistantMsg.

static DtAssistantMsg* DtAssistantRidParamsMsg::create	(	const DtNetAssistantMsgHeader *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

static

Creator for receiving.

static DtAssistantMsg* DtAssistantRidParamsMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

static

Creator for sending.

virtual unsigned DtAssistantRidParamsMsg::federateHandle ( ) const

virtual

Get whether this is a request message, otherwise its a response msg.

virtual MAKRti::DtString DtAssistantRidParamsMsg::federation ( ) const

virtual

Get RID filename.

virtual const char* DtAssistantRidParamsMsg::federationPtr ( ) const

protectedvirtual

Return pointer to RID parameters location in message.

virtual char* DtAssistantRidParamsMsg::federationPtr ( )

protectedvirtual

virtual unsigned long DtAssistantRidParamsMsg::federationSize ( ) const

protectedvirtual

virtual void DtAssistantRidParamsMsg::getRidParams ( MAKRti::DtString & ridParams ) const

virtual

Get RID parameters.

virtual DtAssistantMsgKind DtAssistantRidParamsMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of this message.

Implements DtAssistantMsg.

virtual bool DtAssistantRidParamsMsg::isRequest ( ) const

virtual

Get whether this is a request message, otherwise its a response msg.

virtual int DtAssistantRidParamsMsg::minSize ( ) const

virtual

virtual DtNetAssistantRidParamsMsg* DtAssistantRidParamsMsg::netAssistantRidParamsMsg ( )

protectedvirtual

The network representation.

virtual const DtNetAssistantRidParamsMsg* DtAssistantRidParamsMsg::netAssistantRidParamsMsg ( ) const

protectedvirtual

virtual void DtAssistantRidParamsMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

static void DtAssistantRidParamsMsg::removeCallback	(	DtRtiAssistantClient *	conn,
		DtAssistantRidParamsCb	cb,
		void *	usr
	)

static

static void DtAssistantRidParamsMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantRidParamsCb	cb,
		void *	usr
	)

static

static void DtAssistantRidParamsMsg::removeCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantRidParamsCb	cb,
		void *	usr
	)

static

virtual MAKRti::DtFilename DtAssistantRidParamsMsg::ridFilename ( ) const

virtual

Get RID filename.

virtual const char* DtAssistantRidParamsMsg::ridFilenamePtr ( ) const

protectedvirtual

Return pointer to RID filename name location in message.

virtual char* DtAssistantRidParamsMsg::ridFilenamePtr ( )

protectedvirtual

virtual unsigned long DtAssistantRidParamsMsg::ridFilenameSize ( ) const

protectedvirtual

virtual const char* DtAssistantRidParamsMsg::ridParametersPtr ( ) const

protectedvirtual

Return pointer to RID parameters location in message.

virtual char* DtAssistantRidParamsMsg::ridParametersPtr ( )

protectedvirtual

virtual unsigned long DtAssistantRidParamsMsg::ridParametersSize ( ) const

protectedvirtual

virtual void DtAssistantRidParamsMsg::setFederateHandle ( unsigned hdl )

virtual

Set whether this is a request message, otherwise its a response msg.

virtual void DtAssistantRidParamsMsg::setFederation ( const MAKRti::DtString & federation )

virtual

Set RID filename.

virtual void DtAssistantRidParamsMsg::setFederationSize ( unsigned long size )

protectedvirtual

Set/Get federation name size.

virtual void DtAssistantRidParamsMsg::setIsRequest ( bool isReq )

virtual

Set whether this is a request message, otherwise its a response msg.

virtual void DtAssistantRidParamsMsg::setRidFilename ( const MAKRti::DtFilename & filename )

virtual

Set RID filename.

virtual void DtAssistantRidParamsMsg::setRidFilenameSize ( unsigned long size )

protectedvirtual

Set/Get RID filename size.

virtual void DtAssistantRidParamsMsg::setRidParametersSize ( unsigned long size )

protectedvirtual

Set/Get RID parameters size.

virtual void DtAssistantRidParamsMsg::setRidParams ( const MAKRti::DtString & ridParams )

virtual

Set RID parameters.

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

assistantRidParamsMsg.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation