The DtAssistantConnMsg defines a wrapper for the RTI Assistant connection information message used to send general connection information and status between the Assistant and any connected RTI components. More...

Inheritance diagram for DtAssistantConnMsg:

Collaboration diagram for DtAssistantConnMsg:

List of all members.

Public Member Functions
	DtAssistantConnMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantConnMsg (const DtNetAssistantConnMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtAssistantConnMsg (DtAssistantComponentType componentType, bool disconnect, const MAKRti::DtString &display, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantConnMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual DtAssistantComponentType	componentType () const
	Set/Get component type.
virtual void	setComponentType (DtAssistantComponentType componentType)
virtual bool	isDisconnect () const
	Set/Get disconnect status.
virtual void	setDisconnect (bool val)
virtual void	setDisplay (const MAKRti::DtString &display)
	Set/Get display.
virtual MAKRti::DtString	display () const
virtual void	printData () const
	Print the data section.
Static Public Member Functions
static DtAssistantMsg *	create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators.
static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtRtiAssistantServer conn, DtAssistantConnCb cb, void usr)
	Adds or removes a callback with the given Assistant server for this message type.
static void	removeCallback (DtRtiAssistantServer conn, DtAssistantConnCb cb, void usr)
Protected Member Functions
virtual DtNetAssistantConnMsg *	netAssistantConnMsg ()
	The network representation.
virtual const DtNetAssistantConnMsg *	netAssistantConnMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantConnMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual int	setMinSize (const MAKRti::DtString &text)
	Sets the field sizes for the variant components and returns the minimum size needed for the message, including header.
virtual void	setDisplaySize (unsigned long size)
	Set/Get display string size.
virtual unsigned long	displaySize () const
virtual const char *	displayPtr () const
	Return pointer to display string message.
virtual char *	displayPtr ()

Detailed Description

The DtAssistantConnMsg defines a wrapper for the RTI Assistant connection information message used to send general connection information and status between the Assistant and any connected RTI components.

Constructor & Destructor Documentation

DtAssistantConnMsg::DtAssistantConnMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

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

Referenced by clone(), and create().

DtAssistantConnMsg::DtAssistantConnMsg	(	const DtNetAssistantConnMsg *	netRep,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

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

DtAssistantConnMsg::DtAssistantConnMsg	(	DtAssistantComponentType	componentType,
		bool	disconnect,
		const MAKRti::DtString &	display,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), setComponentType(), setDisconnect(), setDisplay(), and setMinSize().

DtAssistantConnMsg::~DtAssistantConnMsg ( ) [virtual]

Destructor.

Member Function Documentation

void DtAssistantConnMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantConnCb	cb,
		void *	usr
	)		`[static]`

Adds or removes a callback with the given Assistant server for this message type.

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantConnMsgKind.

Referenced by DtAssistantComponentMgr::DtAssistantComponentMgr().

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

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

Implements DtAssistantMsg.

References DtAssistantConnMsg(), and netAssistantConnMsg().

DtAssistantComponentType DtAssistantConnMsg::componentType ( ) const [virtual]

Set/Get component type.

References netAssistantConnMsg().

Referenced by printData(), DtAssistantComponentMgr::processNewConnMsg(), and setComponentType().

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

Creators.

References DtAssistantConnMsg().

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

References DtAssistantConnMsg().

DtString DtAssistantConnMsg::display ( ) const [virtual]

References displayPtr(), and displaySize().

Referenced by printData(), DtAssistantComponentMgr::processNewConnMsg(), and DtRtiAssistantClient::sendConnectMsg().

const char * DtAssistantConnMsg::displayPtr ( ) const [protected, virtual]

Return pointer to display string message.

References netAssistantConnMsg().

Referenced by display(), and setDisplay().

char * DtAssistantConnMsg::displayPtr ( ) [protected, virtual]

References netAssistantConnMsg().

unsigned long DtAssistantConnMsg::displaySize ( ) const [protected, virtual]

References DtNetAssistantConnMsg::displayStrSize, and netAssistantConnMsg().

Referenced by display(), setDisplay(), and setMinSize().

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

Returns the kind of a DtAssistantConnMsg message.

Implements DtAssistantMsg.

References DtAssistantConnMsgKind.

Referenced by DtAssistantConnMsg().

bool DtAssistantConnMsg::isDisconnect ( ) const [virtual]

Set/Get disconnect status.

References DtNetAssistantConnMsg::disconnect, and netAssistantConnMsg().

Referenced by printData(), DtAssistantComponentMgr::processConnMsg(), and DtRtiAssistantClient::sendConnectMsg().

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

Returns minimum size of a message, including header.

Referenced by DtAssistantConnMsg().

DtNetAssistantConnMsg * DtAssistantConnMsg::netAssistantConnMsg ( ) [protected, virtual]

The network representation.

Referenced by clone(), componentType(), displayPtr(), displaySize(), isDisconnect(), setComponentType(), setDisconnect(), and setDisplaySize().

const DtNetAssistantConnMsg * DtAssistantConnMsg::netAssistantConnMsg ( ) const [protected, virtual]

void DtAssistantConnMsg::printData ( ) const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

References componentType(), display(), and isDisconnect().

void DtAssistantConnMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantConnCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantConnMsgKind, and DtRtiAssistantServer::removeMsgCallback().

Referenced by DtAssistantComponentMgr::~DtAssistantComponentMgr().

void DtAssistantConnMsg::setComponentType ( DtAssistantComponentType componentType ) [virtual]

References DtNetAssistantConnMsg::componentType, componentType(), and netAssistantConnMsg().

Referenced by DtAssistantConnMsg(), DtRtiAssistantClient::sendClose(), and DtRtiAssistantClient::sendConnectMsg().

void DtAssistantConnMsg::setDisconnect ( bool val ) [virtual]

References DtNetAssistantConnMsg::disconnect, and netAssistantConnMsg().

Referenced by DtAssistantConnMsg(), DtRtiAssistantServer::readAndProcess(), DtRtiAssistantClient::sendClose(), DtRtiAssistantClient::sendConnectMsg(), and DtRtiAssistantServer::sendConnMsg().

void DtAssistantConnMsg::setDisplay ( const MAKRti::DtString & display ) [virtual]

Set/Get display.

References displayPtr(), displaySize(), rti1516e::insertBytes(), and setDisplaySize().

Referenced by DtAssistantConnMsg(), DtRtiAssistantClient::sendConnectMsg(), and DtRtiAssistantServer::sendConnMsg().

void DtAssistantConnMsg::setDisplaySize ( unsigned long size ) [protected, virtual]

Set/Get display string size.

References DtNetAssistantConnMsg::displayStrSize, and netAssistantConnMsg().

Referenced by setDisplay(), and setMinSize().

int DtAssistantConnMsg::setMinSize ( const MAKRti::DtString & text ) [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 displaySize(), and setDisplaySize().

Referenced by DtAssistantConnMsg().

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