The DtAssistantNotifyMsg defines a wrapper for the RTI Assistant notify message used to send informational text to be displayed and logged by the RTI Assistant. More...

Inheritance diagram for DtAssistantNotifyMsg:

Collaboration diagram for DtAssistantNotifyMsg:

List of all members.

Public Member Functions
	DtAssistantNotifyMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantNotifyMsg (const DtNetAssistantNotifyMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtAssistantNotifyMsg (const MAKRti::DtString &text, DtNotifyLevelType notifyLevel, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantNotifyMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	setNotifyLevel (DtNotifyLevelType level)
	Set notify level.
virtual DtNotifyLevelType	notifyLevel () const
	Get notify level.
virtual void	setText (const MAKRti::DtString &name)
	Set notify text.
virtual MAKRti::DtString	text () const
	Get notify text.
virtual void	setSourceName (const MAKRti::DtString &name)
	Set name of source of message (remote notification viewing only).
virtual MAKRti::DtString	sourceName () const
	Get name of source of message (remote notification viewing only).
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, DtAssistantNotifyCb cb, void usr)
	Adds or removes a callback with the given Assistant server for this message type.
static void	removeCallback (DtRtiAssistantServer conn, DtAssistantNotifyCb cb, void usr)
static void	addCallback (DtRtiAssistantPeer conn, DtAssistantNotifyCb cb, void usr)
	Adds or removes a callback with the given Assistant peer for this message type.
static void	removeCallback (DtRtiAssistantPeer conn, DtAssistantNotifyCb cb, void usr)
Protected Member Functions
virtual DtNetAssistantNotifyMsg *	netAssistantNotifyMsg ()
	The network representation for the notify message.
virtual const DtNetAssistantNotifyMsg *	netAssistantNotifyMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantNotifyMsg 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	setTextSize (unsigned long size)
	Set/Get text size.
virtual unsigned long	textSize () const
virtual const char *	textPtr () const
	Return pointer to text location in message.
virtual char *	textPtr ()
virtual void	setSourceNameSize (unsigned long size)
	Set/Get source name size.
virtual unsigned long	sourceNameSize () const
virtual const char *	sourceNamePtr () const
	Return pointer to text location in message.
virtual char *	sourceNamePtr ()

Detailed Description

The DtAssistantNotifyMsg defines a wrapper for the RTI Assistant notify message used to send informational text to be displayed and logged by the RTI Assistant.

Constructor & Destructor Documentation

DtAssistantNotifyMsg::DtAssistantNotifyMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

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

Referenced by clone(), and create().

DtAssistantNotifyMsg::DtAssistantNotifyMsg	(	const DtNetAssistantNotifyMsg *	netRep,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

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

DtAssistantNotifyMsg::DtAssistantNotifyMsg	(	const MAKRti::DtString &	text,
		DtNotifyLevelType	notifyLevel,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), setMinSize(), setNotifyLevel(), and setText().

DtAssistantNotifyMsg::~DtAssistantNotifyMsg ( ) [virtual]

Destructor.

Member Function Documentation

void DtAssistantNotifyMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantNotifyCb	cb,
		void *	usr
	)		`[static]`

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantNotifyMsgKind.

Referenced by DtAssistantFederationsInfoMgr::DtAssistantFederationsInfoMgr(), DtAssistantNetworkCompViewMgr::DtAssistantNetworkCompViewMgr(), and DtAssistantTrayIconMgr::DtAssistantTrayIconMgr().

void DtAssistantNotifyMsg::addCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantNotifyCb	cb,
		void *	usr
	)		`[static]`

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantNotifyMsgKind.

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

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

Implements DtAssistantMsg.

References DtAssistantNotifyMsg(), and netAssistantNotifyMsg().

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

Creators.

References DtAssistantNotifyMsg().

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

References DtAssistantNotifyMsg().

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

Returns the kind of a DtAssistantNotifyMsg message.

Implements DtAssistantMsg.

References DtAssistantNotifyMsgKind.

Referenced by DtAssistantNotifyMsg().

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

Returns minimum size of a message, including header.

Referenced by DtAssistantNotifyMsg().

DtNetAssistantNotifyMsg * DtAssistantNotifyMsg::netAssistantNotifyMsg ( ) [protected, virtual]

The network representation for the notify message.

Referenced by clone(), notifyLevel(), setNotifyLevel(), setSourceNameSize(), setTextSize(), sourceNameSize(), textPtr(), and textSize().

const DtNetAssistantNotifyMsg * DtAssistantNotifyMsg::netAssistantNotifyMsg ( ) const [protected, virtual]

DtNotifyLevelType DtAssistantNotifyMsg::notifyLevel ( ) const [virtual]

Get notify level.

References netAssistantNotifyMsg().

Referenced by printData(), DtAssistantTrayIconMgr::processNotifyMsg(), and DtAssistantNetworkCompViewMgr::processRtiexecNotifyMsg().

void DtAssistantNotifyMsg::printData ( ) const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

References notifyLevel(), sourceName(), and text().

void DtAssistantNotifyMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantNotifyCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantNotifyMsgKind, and DtRtiAssistantServer::removeMsgCallback().

Referenced by DtAssistantFederationsInfoMgr::~DtAssistantFederationsInfoMgr(), DtAssistantNetworkCompViewMgr::~DtAssistantNetworkCompViewMgr(), and DtAssistantTrayIconMgr::~DtAssistantTrayIconMgr().

void DtAssistantNotifyMsg::removeCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantNotifyCb	cb,
		void *	usr
	)		`[static]`

References DtAssistantNotifyMsgKind, and DtRtiAssistantPeer::removeMsgCallback().

int DtAssistantNotifyMsg::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 setTextSize(), and textSize().

Referenced by DtAssistantNotifyMsg().

void DtAssistantNotifyMsg::setNotifyLevel ( DtNotifyLevelType level ) [virtual]

Set notify level.

References netAssistantNotifyMsg(), and DtNetAssistantNotifyMsg::notifyLevel.

Referenced by DtAssistantNotifyMsg(), DtRtiAssistantClient::sendNotifyMsg(), and DtRtiAssistantPeer::sendNotifyMsg().

void DtAssistantNotifyMsg::setSourceName ( const MAKRti::DtString & name ) [virtual]

Set name of source of message (remote notification viewing only).

References rti1516e::insertBytes(), setSourceNameSize(), sourceNamePtr(), and sourceNameSize().

Referenced by DtRtiAssistantPeer::sendNotifyMsg().

void DtAssistantNotifyMsg::setSourceNameSize ( unsigned long size ) [protected, virtual]

Set/Get source name size.

References netAssistantNotifyMsg(), and DtNetAssistantNotifyMsg::sourceNameSize.

Referenced by setSourceName().

void DtAssistantNotifyMsg::setText ( const MAKRti::DtString & name ) [virtual]

Set notify text.

References rti1516e::insertBytes(), setTextSize(), textPtr(), and textSize().

Referenced by DtAssistantNotifyMsg(), DtRtiAssistantClient::sendNotifyMsg(), and DtRtiAssistantPeer::sendNotifyMsg().

void DtAssistantNotifyMsg::setTextSize ( unsigned long size ) [protected, virtual]

Set/Get text size.

References netAssistantNotifyMsg(), and DtNetAssistantNotifyMsg::textSize.

Referenced by setMinSize(), and setText().

DtString DtAssistantNotifyMsg::sourceName ( ) const [virtual]

Get name of source of message (remote notification viewing only).

References sourceNamePtr(), and sourceNameSize().

Referenced by printData(), and DtAssistantTrayIconMgr::processNotifyMsg().

const char * DtAssistantNotifyMsg::sourceNamePtr ( ) const [protected, virtual]

Return pointer to text location in message.

References textPtr(), and textSize().

Referenced by setSourceName(), and sourceName().

char * DtAssistantNotifyMsg::sourceNamePtr ( ) [protected, virtual]

References textPtr(), and textSize().

unsigned long DtAssistantNotifyMsg::sourceNameSize ( ) const [protected, virtual]

References netAssistantNotifyMsg(), and DtNetAssistantNotifyMsg::sourceNameSize.

Referenced by setSourceName(), and sourceName().

DtString DtAssistantNotifyMsg::text ( ) const [virtual]

Get notify text.

References textPtr(), and textSize().

Referenced by printData(), DtAssistantTrayIconMgr::processNotifyMsg(), and DtAssistantNetworkCompViewMgr::processRtiexecNotifyMsg().

const char * DtAssistantNotifyMsg::textPtr ( ) const [protected, virtual]

Return pointer to text location in message.

References netAssistantNotifyMsg().

Referenced by setText(), sourceNamePtr(), and text().

char * DtAssistantNotifyMsg::textPtr ( ) [protected, virtual]

References netAssistantNotifyMsg().

unsigned long DtAssistantNotifyMsg::textSize ( ) const [protected, virtual]

References netAssistantNotifyMsg(), and DtNetAssistantNotifyMsg::textSize.

Referenced by setMinSize(), setText(), sourceNamePtr(), and text().

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