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:

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

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

Constructor.

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

virtual DtAssistantCommandMsg::~DtAssistantCommandMsg ( )

virtual

Destructor.

Member Function Documentation

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

static

Callback management.

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

static

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

virtual

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

Implements DtAssistantMsg.

virtual DtU8 DtAssistantCommandMsg::commandType ( ) const

virtual

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

static

Creator.

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

static

Creator.

virtual DtAssistantMsgKind DtAssistantCommandMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantCommandMsg Msg.

Implements DtAssistantMsg.

virtual bool DtAssistantCommandMsg::isAssistantToAssistant ( ) const

virtual

virtual MAKRti::DtString DtAssistantCommandMsg::messageString ( ) const

virtual

virtual const char* DtAssistantCommandMsg::messageStringPtr ( ) const

protectedvirtual

Return pointer to display string message.

virtual char* DtAssistantCommandMsg::messageStringPtr ( )

protectedvirtual

virtual unsigned long DtAssistantCommandMsg::messageStringSize ( ) const

protectedvirtual

virtual int DtAssistantCommandMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetAssistantCommandMsg* DtAssistantCommandMsg::netAssistantCommandMsg ( )

protectedvirtual

The network representation.

virtual const DtNetAssistantCommandMsg* DtAssistantCommandMsg::netAssistantCommandMsg ( ) const

protectedvirtual

virtual void DtAssistantCommandMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

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

static

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

static

virtual void DtAssistantCommandMsg::setCommandType ( DtU8 yesNo )

virtual

Get / Set the command value.

virtual void DtAssistantCommandMsg::setIsAssistantToAssistant ( bool yesNo )

virtual

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

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

virtual

Set/Get response string size.

virtual void DtAssistantCommandMsg::setMessageStringSize ( unsigned long size )

protectedvirtual

Set/Get response string size.

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

virtual

set the min size. Performs no allocation.

virtual void DtAssistantCommandMsg::setTargetAssistantComponentId ( const DtU8 assistantId )

virtual

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

virtual void DtAssistantCommandMsg::setTargetFederateHandle ( const DtU16 fedHandle )

virtual

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

virtual void DtAssistantCommandMsg::setTargetFederationHandle ( const DtU16 fedexHandle )

virtual

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

virtual DtU8 DtAssistantCommandMsg::targetAssistantComponentId ( ) const

virtual

virtual DtU16 DtAssistantCommandMsg::targetFederateHandle ( ) const

virtual

virtual DtU16 DtAssistantCommandMsg::targetFederationHandle ( ) const

virtual

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

assistantCommandMsg.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation