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:

List of all members.

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	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	printData () const
	Print the data section.
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)
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 ()

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.

References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), and minSize().

Referenced by clone(), and create().

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

Recv Constructor (from incoming message)

References DtNetAssistantRidParamsMsg::header, and DtAssistantMsg::initAssistantMsg().

DtAssistantRidParamsMsg::~DtAssistantRidParamsMsg ( ) [virtual]

Destructor.

Member Function Documentation

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

References DtRtiAssistantClient::addMsgCallback(), and DtAssistantRidParamsMsgKind.

Referenced by DtAssistantFederationsViewMgr::DtAssistantFederationsViewMgr(), and DtRtiexecObserverForAssistant::DtRtiexecObserverForAssistant().

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantRidParamsMsgKind.

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantRidParamsMsgKind.

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

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

Implements DtAssistantMsg.

References DtAssistantRidParamsMsg(), and netAssistantRidParamsMsg().

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

Creator for receiving.

References DtAssistantRidParamsMsg().

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

Creator for sending.

References DtAssistantRidParamsMsg().

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

Get RID parameters.

References ridParametersPtr(), and ridParametersSize().

Referenced by DtAssistantFederationsViewMgr::processRidParamMsg().

DtAssistantMsgKind DtAssistantRidParamsMsg::internalMsgKind ( ) [protected, virtual]

Returns the kind of this message.

Implements DtAssistantMsg.

References DtAssistantRidParamsMsgKind.

Referenced by DtAssistantRidParamsMsg().

bool DtAssistantRidParamsMsg::isRequest ( ) const [virtual]

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

References DtNetAssistantRidParamsMsg::isRequest, and netAssistantRidParamsMsg().

Referenced by DtAssistantFederationsViewMgr::processRidParamMsg().

int DtAssistantRidParamsMsg::minSize ( ) const [virtual]

Referenced by DtAssistantRidParamsMsg().

DtNetAssistantRidParamsMsg * DtAssistantRidParamsMsg::netAssistantRidParamsMsg ( ) [protected, virtual]

The network representation.

Referenced by clone(), isRequest(), ridFilenamePtr(), ridFilenameSize(), ridParametersSize(), setIsRequest(), setRidFilenameSize(), and setRidParametersSize().

const DtNetAssistantRidParamsMsg * DtAssistantRidParamsMsg::netAssistantRidParamsMsg ( ) const [protected, virtual]

void DtAssistantRidParamsMsg::printData ( ) const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

References ridFilename(), and ridParametersPtr().

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

References DtAssistantRidParamsMsgKind, and DtRtiAssistantClient::removeMsgCallback().

Referenced by DtAssistantFederationsViewMgr::~DtAssistantFederationsViewMgr().

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

References DtAssistantRidParamsMsgKind, and DtRtiAssistantServer::removeMsgCallback().

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

References DtAssistantRidParamsMsgKind, and DtRtiAssistantPeer::removeMsgCallback().

DtFilename DtAssistantRidParamsMsg::ridFilename ( ) const [virtual]

Get RID filename.

References ridFilenamePtr(), and ridFilenameSize().

Referenced by printData(), and DtAssistantFederationsViewMgr::processRidParamMsg().

const char * DtAssistantRidParamsMsg::ridFilenamePtr ( ) const [protected, virtual]

Return pointer to RID filename name location in message.

References netAssistantRidParamsMsg().

Referenced by ridFilename(), ridParametersPtr(), and setRidFilename().

char * DtAssistantRidParamsMsg::ridFilenamePtr ( ) [protected, virtual]

References netAssistantRidParamsMsg().

unsigned long DtAssistantRidParamsMsg::ridFilenameSize ( ) const [protected, virtual]

References netAssistantRidParamsMsg(), and DtNetAssistantRidParamsMsg::ridFilenameSize.

Referenced by ridFilename(), ridParametersPtr(), and setRidFilename().

const char * DtAssistantRidParamsMsg::ridParametersPtr ( ) const [protected, virtual]

Return pointer to RID parameters location in message.

References ridFilenamePtr(), and ridFilenameSize().

Referenced by getRidParams(), printData(), and setRidParams().

char * DtAssistantRidParamsMsg::ridParametersPtr ( ) [protected, virtual]

References ridFilenamePtr(), and ridFilenameSize().

unsigned long DtAssistantRidParamsMsg::ridParametersSize ( ) const [protected, virtual]

References netAssistantRidParamsMsg(), and DtNetAssistantRidParamsMsg::ridParamsSize.

Referenced by getRidParams(), and setRidParams().

void DtAssistantRidParamsMsg::setIsRequest ( bool isReq ) [virtual]

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

References DtNetAssistantRidParamsMsg::isRequest, and netAssistantRidParamsMsg().

Referenced by DtRtiAssistantExecClient::sendRidParamsMsg(), DtRtiAssistantServer::sendRidParamsRequestMsg(), and DtRtiAssistantPeer::sendRidParamsRequestMsg().

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

Set RID filename.

References rti1516e::insertBytes(), ridFilenamePtr(), ridFilenameSize(), and setRidFilenameSize().

Referenced by DtRtiAssistantExecClient::sendRidParamsMsg().

void DtAssistantRidParamsMsg::setRidFilenameSize ( unsigned long size ) [protected, virtual]

Set/Get RID filename size.

References netAssistantRidParamsMsg(), and DtNetAssistantRidParamsMsg::ridFilenameSize.

Referenced by setRidFilename().

void DtAssistantRidParamsMsg::setRidParametersSize ( unsigned long size ) [protected, virtual]

Set/Get RID parameters size.

References netAssistantRidParamsMsg(), and DtNetAssistantRidParamsMsg::ridParamsSize.

Referenced by setRidParams().

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

Set RID parameters.

References rti1516e::insertBytes(), ridParametersPtr(), ridParametersSize(), and setRidParametersSize().

Referenced by DtRtiAssistantExecClient::sendRidParamsMsg().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation