DtAssistantNotifyObserveMsg Class Reference

The DtAssistantNotifyObserveMsg defines a wrapper for the RTI Assistant message used by the Assistant to inform remote Assistants that it wants to receive all notification messages. More...

Inheritance diagram for DtAssistantNotifyObserveMsg:

Collaboration diagram for DtAssistantNotifyObserveMsg:

List of all members.

Public Member Functions
	DtAssistantNotifyObserveMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtAssistantNotifyObserveMsg (const DtNetAssistantNotifyObserveMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtAssistantNotifyObserveMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual bool	isObserved () const
	Returns whether notifications are or are not being observed.
virtual void	setIsObserved (bool observed)
	Set whether notifications are or are not being observed.
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 (DtRtiAssistantPeer *conn, DtAssistantNotifyObserveCb cb, void *usr)
	Adds or removes a callback with the given Assistant peer for this message type.
static void	removeCallback (DtRtiAssistantPeer *conn, DtAssistantNotifyObserveCb cb, void *usr)
Protected Member Functions
virtual DtNetAssistantNotifyObserveMsg *	netAssistantNotifyObserveMsg ()
	The network representation for the state observe message.
virtual const DtNetAssistantNotifyObserveMsg *	netAssistantNotifyObserveMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantExitMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.

---

Detailed Description

The DtAssistantNotifyObserveMsg defines a wrapper for the RTI Assistant message used by the Assistant to inform remote Assistants that it wants to receive all notification messages.

---

Constructor & Destructor Documentation

DtAssistantNotifyObserveMsg::DtAssistantNotifyObserveMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

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

Referenced by clone(), and create().

DtAssistantNotifyObserveMsg::DtAssistantNotifyObserveMsg	(	const DtNetAssistantNotifyObserveMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

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

DtAssistantNotifyObserveMsg::~DtAssistantNotifyObserveMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtAssistantNotifyObserveMsg::addCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantNotifyObserveCb	cb,
		void *	usr
	)		[static]

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantNotifyObserveMsgKind.

Referenced by DtAssistantTrayIconMgr::DtAssistantTrayIconMgr().

DtAssistantMsg * DtAssistantNotifyObserveMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtAssistantMsg.

References DtAssistantNotifyObserveMsg(), and netAssistantNotifyObserveMsg().

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

Creators.

References DtAssistantNotifyObserveMsg().

DtAssistantMsg * DtAssistantNotifyObserveMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

References DtAssistantNotifyObserveMsg().

DtAssistantMsgKind DtAssistantNotifyObserveMsg::internalMsgKind

(

)

[protected, virtual]

Returns the kind of a DtAssistantExitMsg message.

Implements DtAssistantMsg.

References DtAssistantNotifyObserveMsgKind.

Referenced by DtAssistantNotifyObserveMsg().

bool DtAssistantNotifyObserveMsg::isObserved

(

)

const [virtual]

Returns whether notifications are or are not being observed.

References DtNetAssistantNotifyObserveMsg::isObserved, and netAssistantNotifyObserveMsg().

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

int DtAssistantNotifyObserveMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtAssistantNotifyObserveMsg().

DtNetAssistantNotifyObserveMsg * DtAssistantNotifyObserveMsg::netAssistantNotifyObserveMsg

(

)

[protected, virtual]

The network representation for the state observe message.

Referenced by clone(), isObserved(), and setIsObserved().

const DtNetAssistantNotifyObserveMsg * DtAssistantNotifyObserveMsg::netAssistantNotifyObserveMsg

(

)

const [protected, virtual]

void DtAssistantNotifyObserveMsg::printData

(

)

const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

References isObserved().

void DtAssistantNotifyObserveMsg::removeCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantNotifyObserveCb	cb,
		void *	usr
	)		[static]

References DtAssistantNotifyObserveMsgKind, and DtRtiAssistantPeer::removeMsgCallback().

void DtAssistantNotifyObserveMsg::setIsObserved

(

bool

observed

)

[virtual]

Set whether notifications are or are not being observed.

References DtNetAssistantNotifyObserveMsg::isObserved, and netAssistantNotifyObserveMsg().

Referenced by DtRtiAssistantPeer::sendNotifyObserveMsg().

---

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

• assistantNotifyObserveMsg.h
• assistantNotifyObserveMsg.cxx