The DtAssistantPopupMsg defines a wrapper for the RTI Assistant Popup message used to send informational text to be displayed as a dialog by the RTI Assistant. More...

Inheritance diagram for DtAssistantPopupMsg:

Collaboration diagram for DtAssistantPopupMsg:

Public Member Functions
	DtAssistantPopupMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantPopupMsg (const DtNetAssistantPopupMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtAssistantPopupMsg (const MAKRti::DtString &text, const MAKRti::DtString &advancedText, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantPopupMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual MAKRti::DtString	text () const
	Get Popup text.
virtual MAKRti::DtString	advancedText () const
	Get Advanced Popup text.
virtual void	printData () const
	Print the data section.
virtual void	set (const MAKRti::DtString &text, const MAKRti::DtString &advanced)
	Public function to set the text fields.
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)
	Creators.
static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtRtiAssistantServer conn, DtAssistantPopupCb cb, void usr)
	Adds or removes a callback with the given Assistant server for this message type.
static void	removeCallback (DtRtiAssistantServer conn, DtAssistantPopupCb cb, void usr)
static void	addCallback (DtRtiAssistantPeer conn, DtAssistantPopupCb cb, void usr)
	Adds or removes a callback with the given Assistant peer for this message type.
static void	removeCallback (DtRtiAssistantPeer conn, DtAssistantPopupCb cb, void usr)
static void	addCallback (DtAssistantMsgQueue queue, DtAssistantPopupCb cb, void usr)
	Adds or removes a callback with the given Assistant message queue for this message type.
static void	removeCallback (DtAssistantMsgQueue queue, DtAssistantPopupCb 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 void	setAdvancedText (const MAKRti::DtString &advanced)
	Set Popup Advanced text.
virtual void	setText (const MAKRti::DtString &name)
	Set Popup text.
virtual DtNetAssistantPopupMsg *	netAssistantPopupMsg ()
	The network representation for the Popup message.
virtual const DtNetAssistantPopupMsg *	netAssistantPopupMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantPopupMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual int	setMinSize (const MAKRti::DtString &text, const MAKRti::DtString &advanced)
	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 void	setAdvancedTextSize (unsigned long size)
	Set/Get text size.
virtual unsigned long	advancedTextSize () const
virtual const char *	textPtr () const
	Return pointer to text location in message.
virtual char *	textPtr ()
virtual const char *	advancedTextPtr () const
	Return pointer to advanced text location in message.
virtual char *	advancedTextPtr ()
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 DtAssistantPopupMsg defines a wrapper for the RTI Assistant Popup message used to send informational text to be displayed as a dialog by the RTI Assistant.

Constructor & Destructor Documentation

DtAssistantPopupMsg::DtAssistantPopupMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

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

Referenced by clone(), and create().

DtAssistantPopupMsg::DtAssistantPopupMsg	(	const DtNetAssistantPopupMsg *	netRep,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

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

DtAssistantPopupMsg::DtAssistantPopupMsg	(	const MAKRti::DtString &	text,
		const MAKRti::DtString &	advancedText,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

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

DtAssistantPopupMsg::~DtAssistantPopupMsg ( )

virtual

Destructor.

Member Function Documentation

void DtAssistantPopupMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantPopupCb	cb,
		void *	usr
	)

static

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantPopupMsgKind.

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

void DtAssistantPopupMsg::addCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantPopupCb	cb,
		void *	usr
	)

static

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantPopupMsgKind.

void DtAssistantPopupMsg::addCallback	(	DtAssistantMsgQueue *	queue,
		DtAssistantPopupCb	cb,
		void *	usr
	)

static

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

References DtAssistantMsgQueue::addMsgCallback(), and DtAssistantPopupMsgKind.

DtString DtAssistantPopupMsg::advancedText ( ) const

virtual

Get Advanced Popup text.

References advancedTextPtr(), and advancedTextSize().

Referenced by DtAssistantPopupMsgMgr::addPopupMsgToQueue(), printData(), DtAssistantPopupMsgMgr::processPopupMsg(), and DtAssistantFederationsInfoMgr::processRemoteRtiexecPopupMsg().

const char * DtAssistantPopupMsg::advancedTextPtr ( ) const

protectedvirtual

Return pointer to advanced text location in message.

References textPtr(), and textSize().

Referenced by advancedText(), and setAdvancedText().

char * DtAssistantPopupMsg::advancedTextPtr ( )

protectedvirtual

References textPtr(), and textSize().

unsigned long DtAssistantPopupMsg::advancedTextSize ( ) const

protectedvirtual

References DtNetAssistantPopupMsg::advancedTextSize, and netAssistantPopupMsg().

Referenced by advancedText(), setAdvancedText(), and setMinSize().

DtAssistantMsg * DtAssistantPopupMsg::clone ( bool copy = true ) const

virtual

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

Implements DtAssistantMsg.

References DtAssistantPopupMsg(), and netAssistantPopupMsg().

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

static

Creators.

References DtAssistantPopupMsg().

DtAssistantMsg * DtAssistantPopupMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

static

References DtAssistantPopupMsg().

DtAssistantMsgKind DtAssistantPopupMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantPopupMsg message.

Implements DtAssistantMsg.

References DtAssistantPopupMsgKind.

Referenced by DtAssistantPopupMsg().

int DtAssistantPopupMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtAssistantPopupMsg().

DtNetAssistantPopupMsg * DtAssistantPopupMsg::netAssistantPopupMsg ( )

protectedvirtual

The network representation for the Popup message.

Referenced by advancedTextSize(), clone(), setAdvancedTextSize(), setTextSize(), textPtr(), and textSize().

const DtNetAssistantPopupMsg * DtAssistantPopupMsg::netAssistantPopupMsg ( ) const

protectedvirtual

void DtAssistantPopupMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

References advancedText(), and text().

void DtAssistantPopupMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantPopupCb	cb,
		void *	usr
	)

static

References DtAssistantPopupMsgKind, and DtRtiAssistantServer::removeMsgCallback().

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

void DtAssistantPopupMsg::removeCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantPopupCb	cb,
		void *	usr
	)

static

References DtAssistantPopupMsgKind, and DtRtiAssistantPeer::removeMsgCallback().

void DtAssistantPopupMsg::removeCallback	(	DtAssistantMsgQueue *	queue,
		DtAssistantPopupCb	cb,
		void *	usr
	)

static

References DtAssistantPopupMsgKind, and DtAssistantMsgQueue::removeMsgCallback().

void DtAssistantPopupMsg::set	(	const MAKRti::DtString &	text,
		const MAKRti::DtString &	advanced
	)

virtual

Public function to set the text fields.

References setAdvancedText(), and setText().

Referenced by DtRtiAssistantClient::sendDialogBoxMsg().

void DtAssistantPopupMsg::setAdvancedText ( const MAKRti::DtString & advanced )

protectedvirtual

Set Popup Advanced text.

References advancedTextPtr(), advancedTextSize(), rti1516e::insertBytes(), and setAdvancedTextSize().

Referenced by DtAssistantPopupMsg(), and set().

void DtAssistantPopupMsg::setAdvancedTextSize ( unsigned long size )

protectedvirtual

Set/Get text size.

References DtNetAssistantPopupMsg::advancedTextSize, and netAssistantPopupMsg().

Referenced by setAdvancedText(), and setMinSize().

int DtAssistantPopupMsg::setMinSize	(	const MAKRti::DtString &	text,
		const MAKRti::DtString &	advanced
	)

protectedvirtual

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 advancedTextSize(), setAdvancedTextSize(), setTextSize(), and textSize().

Referenced by DtAssistantPopupMsg().

void DtAssistantPopupMsg::setText ( const MAKRti::DtString & name )

protectedvirtual

Set Popup text.

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

Referenced by DtAssistantPopupMsg(), and set().

void DtAssistantPopupMsg::setTextSize ( unsigned long size )

protectedvirtual

Set/Get text size.

References netAssistantPopupMsg(), and DtNetAssistantPopupMsg::textSize.

Referenced by setMinSize(), and setText().

DtString DtAssistantPopupMsg::text ( ) const

virtual

Get Popup text.

References textPtr(), and textSize().

Referenced by DtAssistantPopupMsgMgr::addPopupMsgToQueue(), printData(), DtAssistantPopupMsgMgr::processPopupMsg(), and DtAssistantFederationsInfoMgr::processRemoteRtiexecPopupMsg().

const char * DtAssistantPopupMsg::textPtr ( ) const

protectedvirtual

Return pointer to text location in message.

References netAssistantPopupMsg().

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

char * DtAssistantPopupMsg::textPtr ( )

protectedvirtual

References netAssistantPopupMsg().

unsigned long DtAssistantPopupMsg::textSize ( ) const

protectedvirtual

References netAssistantPopupMsg(), and DtNetAssistantPopupMsg::textSize.

Referenced by advancedTextPtr(), setMinSize(), setText(), 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