The DtAssistantCommandMsg defines a wrapper for the messages sent to and from the Assistant to deliver commands to the assistant. More...

Inheritance diagram for DtAssistantCommandMsg:

Collaboration diagram for DtAssistantCommandMsg:

List of all members.

Public Types
enum	DtCommandEnum { DtDoNotCommand = 0, DtRequestCommand, DtForceCommand }
Public Member Functions
	DtAssistantCommandMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtAssistantCommandMsg (const DtNetAssistantCommandMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtAssistantCommandMsg (DtU8 commandType, const MAKRti::DtString &messageString="", const DtU8 assistantId=0, const DtU16 fedexHandle=0, const DtU16 fedHandle=0, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantCommandMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	setIsAssistantToAssistant (bool yesNo)
	Get / Set whether this is from an assistant to assistant client.
virtual bool	isAssistantToAssistant () const
virtual void	setCommandType (DtU8 yesNo)
	Get / Set the command value.
virtual DtU8	commandType () const
virtual void	printData () const
	Print the data section.
virtual int	setMinSize (const MAKRti::DtString &text)
	set the min size. Performs no allocation.
virtual void	setMessageString (const MAKRti::DtString &msgString)
	Set/Get response string size.
virtual MAKRti::DtString	messageString () const
virtual void	setTargetAssistantComponentId (const DtU8 assistantId)
	set the assistant "handle" this is addressed to only pertinent to the {delete, stopForwarder, stopRtiExec} commands.
virtual DtU8	targetAssistantComponentId () const
virtual void	setTargetFederationHandle (const DtU16 fedexHandle)
	set the federation handle this is addressed to only pertinent to the delete command.
virtual DtU16	targetFederationHandle () const
virtual void	setTargetFederateHandle (const DtU16 fedHandle)
	set the federate handle this is addressed to only pertinent to the delete command.
virtual DtU16	targetFederateHandle () const
Static Public Member Functions
static DtAssistantMsg *	create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creator.
static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creator.
static void	addCallback (DtRtiAssistantServer conn, DtAssistantCommandMsgCb cb, void usr)
	Callback management.
static void	removeCallback (DtRtiAssistantServer conn, DtAssistantCommandMsgCb cb, void usr)
static void	addCallback (DtAssistantMsgQueue queue, DtAssistantCommandMsgCb cb, void usr)
static void	removeCallback (DtAssistantMsgQueue queue, DtAssistantCommandMsgCb cb, void usr)
Protected Member Functions
virtual DtNetAssistantCommandMsg *	netAssistantCommandMsg ()
	The network representation.
virtual const DtNetAssistantCommandMsg *	netAssistantCommandMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantCommandMsg Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual void	setMessageStringSize (unsigned long size)
	Set/Get response string size.
virtual unsigned long	messageStringSize () const
virtual const char *	messageStringPtr () const
	Return pointer to display string message.
virtual char *	messageStringPtr ()

Detailed Description

The DtAssistantCommandMsg defines a wrapper for the messages sent to and from the Assistant to deliver commands to the assistant.

Member Enumeration Documentation

enum DtAssistantCommandMsg::DtCommandEnum

Enumerator:

DtDoNotCommand
DtRequestCommand
DtForceCommand

Constructor & Destructor Documentation

DtAssistantCommandMsg::DtAssistantCommandMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructor.

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

Referenced by clone(), and create().

DtAssistantCommandMsg::DtAssistantCommandMsg	(	const DtNetAssistantCommandMsg *	netRep,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

Constructor.

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

DtAssistantCommandMsg::DtAssistantCommandMsg	(	DtU8	commandType,
		const MAKRti::DtString &	messageString = `""`,
		const DtU8	assistantId = `0`,
		const DtU16	fedexHandle = `0`,
		const DtU16	fedHandle = `0`,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), minSize(), setCommandType(), setMessageString(), setMinSize(), setTargetAssistantComponentId(), setTargetFederateHandle(), and setTargetFederationHandle().

DtAssistantCommandMsg::~DtAssistantCommandMsg ( ) [virtual]

Destructor.

Member Function Documentation

void DtAssistantCommandMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantCommandMsgCb	cb,
		void *	usr
	)		`[static]`

Callback management.

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantCommandMsgKind.

Referenced by DtAssistantFederationsInfoMgr::DtAssistantFederationsInfoMgr(), and DtAssistantNetworkCompInfoMgr::DtAssistantNetworkCompInfoMgr().

void DtAssistantCommandMsg::addCallback	(	DtAssistantMsgQueue *	queue,
		DtAssistantCommandMsgCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantMsgQueue::addMsgCallback(), and DtAssistantCommandMsgKind.

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

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

Implements DtAssistantMsg.

References DtAssistantCommandMsg(), and netAssistantCommandMsg().

DtU8 DtAssistantCommandMsg::commandType ( ) const [virtual]

References DtNetAssistantCommandMsg::command, and netAssistantCommandMsg().

Referenced by printData(), DtAssistantNetworkCompInfoMgr::processAssistantCommandMsg(), and DtAssistantFederationsInfoMgr::processAssistantCommandMsg().

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

Creator.

References DtAssistantCommandMsg().

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

Creator.

References DtAssistantCommandMsg().

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

Returns the kind of a DtAssistantCommandMsg Msg.

Implements DtAssistantMsg.

References DtAssistantCommandMsgKind.

Referenced by DtAssistantCommandMsg().

bool DtAssistantCommandMsg::isAssistantToAssistant ( ) const [virtual]

References DtNetAssistantCommandMsg::assistant, and netAssistantCommandMsg().

DtString DtAssistantCommandMsg::messageString ( ) const [virtual]

References messageStringPtr(), and messageStringSize().

Referenced by printData(), and DtRtiAssistantToAssistantClient::sendInteractiveCommandMessage().

const char * DtAssistantCommandMsg::messageStringPtr ( ) const [protected, virtual]

Return pointer to display string message.

References netAssistantCommandMsg().

Referenced by messageString(), and setMessageString().

char * DtAssistantCommandMsg::messageStringPtr ( ) [protected, virtual]

References netAssistantCommandMsg().

unsigned long DtAssistantCommandMsg::messageStringSize ( ) const [protected, virtual]

References netAssistantCommandMsg(), and DtNetAssistantCommandMsg::payloadSize.

Referenced by messageString(), printData(), setMessageString(), and setMinSize().

int DtAssistantCommandMsg::minSize ( ) const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtAssistantCommandMsg().

DtNetAssistantCommandMsg * DtAssistantCommandMsg::netAssistantCommandMsg ( ) [protected, virtual]

The network representation.

Referenced by clone(), commandType(), isAssistantToAssistant(), messageStringPtr(), messageStringSize(), setCommandType(), setIsAssistantToAssistant(), setMessageStringSize(), setTargetAssistantComponentId(), setTargetFederateHandle(), setTargetFederationHandle(), targetAssistantComponentId(), targetFederateHandle(), and targetFederationHandle().

const DtNetAssistantCommandMsg * DtAssistantCommandMsg::netAssistantCommandMsg ( ) const [protected, virtual]

void DtAssistantCommandMsg::printData ( ) const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

References commandType(), DtAssistantCommandDeleteFederate, messageString(), messageStringSize(), targetAssistantComponentId(), targetFederateHandle(), and targetFederationHandle().

void DtAssistantCommandMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantCommandMsgCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantCommandMsgKind, and DtRtiAssistantServer::removeMsgCallback().

Referenced by DtAssistantFederationsInfoMgr::~DtAssistantFederationsInfoMgr(), and DtAssistantNetworkCompInfoMgr::~DtAssistantNetworkCompInfoMgr().

void DtAssistantCommandMsg::removeCallback	(	DtAssistantMsgQueue *	queue,
		DtAssistantCommandMsgCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantCommandMsgKind, and DtAssistantMsgQueue::removeMsgCallback().

void DtAssistantCommandMsg::setCommandType ( DtU8 yesNo ) [virtual]

Get / Set the command value.

References DtNetAssistantCommandMsg::command, and netAssistantCommandMsg().

Referenced by DtAssistantCommandMsg(), DtRtiAssistantToAssistantClient::sendCommandMessage(), and DtRtiAssistantToAssistantClient::sendInteractiveCommandMessage().

void DtAssistantCommandMsg::setIsAssistantToAssistant ( bool yesNo ) [virtual]

Get / Set whether this is from an assistant to assistant client.

References DtNetAssistantCommandMsg::assistant, and netAssistantCommandMsg().

Referenced by DtAssistantFederationsInfoMgr::processAssistantCommandMsg(), DtRtiAssistantToAssistantClient::sendCommandMessage(), and DtRtiAssistantToAssistantClient::sendInteractiveCommandMessage().

void DtAssistantCommandMsg::setMessageString ( const MAKRti::DtString & msgString ) [virtual]

Set/Get response string size.

References rti1516e::insertBytes(), messageStringPtr(), messageStringSize(), and setMessageStringSize().

Referenced by DtAssistantCommandMsg(), DtAssistantFederationsInfoMgr::processAssistantCommandMsg(), and DtRtiAssistantServer::sendAssistantCommandResponseMsg().

void DtAssistantCommandMsg::setMessageStringSize ( unsigned long size ) [protected, virtual]

Set/Get response string size.

References netAssistantCommandMsg(), and DtNetAssistantCommandMsg::payloadSize.

Referenced by setMessageString(), and setMinSize().

int DtAssistantCommandMsg::setMinSize ( const MAKRti::DtString & text ) [virtual]

set the min size. Performs no allocation.

References messageStringSize(), and setMessageStringSize().

Referenced by DtAssistantCommandMsg().

void DtAssistantCommandMsg::setTargetAssistantComponentId ( const DtU8 assistantId ) [virtual]

set the assistant "handle" this is addressed to only pertinent to the {delete, stopForwarder, stopRtiExec} commands.

References DtNetAssistantCommandMsg::assistantHandle, and netAssistantCommandMsg().

Referenced by DtAssistantCommandMsg(), DtRtiAssistantToAssistantClient::sendCommandMessage(), and DtRtiAssistantToAssistantClient::sendInteractiveCommandMessage().

void DtAssistantCommandMsg::setTargetFederateHandle ( const DtU16 fedHandle ) [virtual]

set the federate handle this is addressed to only pertinent to the delete command.

References DtNetAssistantCommandMsg::federateHandle, and netAssistantCommandMsg().

Referenced by DtAssistantCommandMsg(), DtRtiAssistantToAssistantClient::sendCommandMessage(), and DtRtiAssistantToAssistantClient::sendInteractiveCommandMessage().

void DtAssistantCommandMsg::setTargetFederationHandle ( const DtU16 fedexHandle ) [virtual]

set the federation handle this is addressed to only pertinent to the delete command.

References DtNetAssistantCommandMsg::federationHandle, and netAssistantCommandMsg().

Referenced by DtAssistantCommandMsg(), DtRtiAssistantToAssistantClient::sendCommandMessage(), and DtRtiAssistantToAssistantClient::sendInteractiveCommandMessage().

DtU8 DtAssistantCommandMsg::targetAssistantComponentId ( ) const [virtual]

References DtNetAssistantCommandMsg::assistantHandle, and netAssistantCommandMsg().

Referenced by printData(), and DtAssistantFederationsInfoMgr::processAssistantCommandMsg().

DtU16 DtAssistantCommandMsg::targetFederateHandle ( ) const [virtual]

References DtNetAssistantCommandMsg::federateHandle, and netAssistantCommandMsg().

Referenced by printData(), and DtAssistantFederationsInfoMgr::processAssistantCommandMsg().

DtU16 DtAssistantCommandMsg::targetFederationHandle ( ) const [virtual]

References DtNetAssistantCommandMsg::federationHandle, and netAssistantCommandMsg().

Referenced by printData(), and DtAssistantFederationsInfoMgr::processAssistantCommandMsg().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation