makVrv::DtChannelKeywordCompass Class Reference

The base class for all channel keyword objects. More...

Inheritance diagram for makVrv::DtChannelKeywordCompass:

List of all members.

Public Member Functions
virtual	~DtChannelKeywordCompass ()
	DTOR.
virtual void	channelNameChanged (const std::string &displayName, const std::string &windowName, const std::string &channelName)
	Implementing objects use this method to respond to changes in the fully qualified name of their channel [display name / window name / channel name ].
virtual void	channelConfigurationChanged (const DtChannelConfiguration &config)
	Implementing objects use this method to respond to changes in channel configuration other than name, which is handled above.
virtual void	windowConfigurationChanged (const DtWindowConfiguration &config)
	Implementing objects use this method to respond to changes in window configuration other than name, which is handled above.
DtChannelCompassAgent *	compassAgent ()
	Agent used to manage the compass.
Protected Member Functions
virtual void	slot_observerCreated (DtInputDriver *, DtObserver *observer)
virtual void	slot_observerToBeDestroyed (DtInputDriver *, DtObserver *observer)
virtual void	slot_observerModeChanged (DtObserver *observer, int newMode)
virtual void	slot_observerModeSettingChanged (int mode, int setting)
virtual void	connectToObserver (DtObserver *observer)
virtual void	connectToObserver (const std::string &observerName)
virtual void	disconnectFromObserver ()
virtual void	updateCompassState ()
	DtChannelKeywordCompass (DtDe &de, const std::string &keyword, const std::string &displayName, const std::string &windowName, const DtChannelConfiguration &channelConfig)
	CTOR.
Protected Attributes
DtChannelCompassAgent *	myCompassAgent
std::string	myObserverName
DtObserver *	myObserver
std::string	myKeyword
std::string	myDisplayName
std::string	myWindowName
std::string	myChannelName
DtSignalConnectionManager	myConnections
Friends
class	DtChannelKeywordLargeCompassCreator
	Only the creator can construct this object.
class	DtChannelKeywordSmallCompassCreator

---

Detailed Description

The base class for all channel keyword objects.

---

Constructor & Destructor Documentation

virtual makVrv::DtChannelKeywordCompass::~DtChannelKeywordCompass

(

)

[virtual]

DTOR.

makVrv::DtChannelKeywordCompass::DtChannelKeywordCompass	(	DtDe &	de,
		const std::string &	keyword,
		const std::string &	displayName,
		const std::string &	windowName,
		const DtChannelConfiguration &	channelConfig
	)		[protected]

CTOR.

---

Member Function Documentation

virtual void makVrv::DtChannelKeywordCompass::channelNameChanged	(	const std::string &	displayName,
		const std::string &	windowName,
		const std::string &	channelName
	)		[virtual]

Implementing objects use this method to respond to changes in the fully qualified name of their channel [display name / window name / channel name ].

Implements makVrv::DtChannelKeywordObject.

virtual void makVrv::DtChannelKeywordCompass::channelConfigurationChanged

(

const DtChannelConfiguration &

config

)

[virtual]

Implementing objects use this method to respond to changes in channel configuration other than name, which is handled above.

Implements makVrv::DtChannelKeywordObject.

virtual void makVrv::DtChannelKeywordCompass::windowConfigurationChanged

(

const DtWindowConfiguration &

config

)

[inline, virtual]

Implementing objects use this method to respond to changes in window configuration other than name, which is handled above.

Implements makVrv::DtChannelKeywordObject.

DtChannelCompassAgent* makVrv::DtChannelKeywordCompass::compassAgent

(

)

Agent used to manage the compass.

virtual void makVrv::DtChannelKeywordCompass::slot_observerCreated	(	DtInputDriver *	,
		DtObserver *	observer
	)		[protected, virtual]

virtual void makVrv::DtChannelKeywordCompass::slot_observerToBeDestroyed	(	DtInputDriver *	,
		DtObserver *	observer
	)		[protected, virtual]

virtual void makVrv::DtChannelKeywordCompass::slot_observerModeChanged	(	DtObserver *	observer,
		int	newMode
	)		[protected, virtual]

virtual void makVrv::DtChannelKeywordCompass::slot_observerModeSettingChanged	(	int	mode,
		int	setting
	)		[protected, virtual]

virtual void makVrv::DtChannelKeywordCompass::connectToObserver

(

DtObserver *

observer

)

[protected, virtual]

virtual void makVrv::DtChannelKeywordCompass::connectToObserver

(

const std::string &

observerName

)

[protected, virtual]

virtual void makVrv::DtChannelKeywordCompass::disconnectFromObserver

(

)

[protected, virtual]

virtual void makVrv::DtChannelKeywordCompass::updateCompassState

(

)

[protected, virtual]

---

Friends And Related Function Documentation

friend class DtChannelKeywordLargeCompassCreator [friend]

Only the creator can construct this object.

friend class DtChannelKeywordSmallCompassCreator [friend]

---

Member Data Documentation

DtChannelCompassAgent* makVrv::DtChannelKeywordCompass::myCompassAgent [protected]

std::string makVrv::DtChannelKeywordCompass::myObserverName [protected]

DtObserver* makVrv::DtChannelKeywordCompass::myObserver [protected]

std::string makVrv::DtChannelKeywordCompass::myKeyword [protected]

std::string makVrv::DtChannelKeywordCompass::myDisplayName [protected]

std::string makVrv::DtChannelKeywordCompass::myWindowName [protected]

std::string makVrv::DtChannelKeywordCompass::myChannelName [protected]

DtSignalConnectionManager makVrv::DtChannelKeywordCompass::myConnections [protected]

---

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

• include/vrvCore/DtChannelKeywordCompass.h