makVrf::DtExtendedLabelsManager Class Reference

This class manages the extended labels that are available for setting in this scenario. More...

Inheritance diagram for makVrf::DtExtendedLabelsManager:

Public Member Functions
	DtExtendedLabelsManager (makVrv::DtDe &)
virtual	~DtExtendedLabelsManager ()
virtual const std::map< int, DtString > &	extendedLabels () const
	If there are extended labels in the session, these are them.
virtual DtString	extendedLabel (int) const
	Returns the title of the extended label (if exists)
virtual void	setExtendedLabels (const std::map< int, DtString > &, bool sendMessage=true)
	Sets the extended labels that are available in the system.
virtual void	requestExtendedLabels ()
	Requests current extended labels.
virtual void	processExtendedLabelsOperationMessage (DtSimMessage *)
	Called when an extended label operation message is received.
virtual void	setupSymbolDecorations ()
virtual bool	hasIndex (int) const
	Returns true if the index exists.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtExtendedLabelsManager &	instance (makVrv::DtDe &de)
	Returns instance of the DtExtendedLabelsManager.
static void	registerInstance (makVrv::DtDe &de, DtExtendedLabelsManager *)

Public Attributes
boost::signal< void()>	signal_extendedLabelsChanged
	Signal sent on receipt of contents of extended labels and those labels are different than what is currently set internally.
boost::signal< void()>	signal_extendedLabelsSet
	Signal when the extended labels are changed via a set or remove – not due to network change.

Protected Member Functions
virtual void	removeAllExtendedLabels (std::set< std::string > &) const
	Removes all extended label symbol decorations from the given set.
virtual void	addAllExtendedLabels (std::set< std::string > &) const
	Adds all extended label symbol decorations to the given set.
virtual void	slot_backendDiscovered ()
virtual int	labelMax () const

Protected Attributes
std::map< int, DtString >	myExtendedLabels
std::set< std::string >	myCreators
makVrv::DtDe &	myDe
bool	myInitialized

Detailed Description

This class manages the extended labels that are available for setting in this scenario.

Constructor & Destructor Documentation

makVrf::DtExtendedLabelsManager::DtExtendedLabelsManager

(

makVrv::DtDe &

)

virtual makVrf::DtExtendedLabelsManager::~DtExtendedLabelsManager ( )

virtual

Member Function Documentation

static DtExtendedLabelsManager& makVrf::DtExtendedLabelsManager::instance ( makVrv::DtDe &  de )

static

Returns instance of the DtExtendedLabelsManager.

static void makVrf::DtExtendedLabelsManager::registerInstance ( makVrv::DtDe &  de, DtExtendedLabelsManager *    )

static

virtual const std::map<int, DtString>& makVrf::DtExtendedLabelsManager::extendedLabels ( ) const

virtual

If there are extended labels in the session, these are them.

virtual DtString makVrf::DtExtendedLabelsManager::extendedLabel ( int  ) const

virtual

Returns the title of the extended label (if exists)

virtual void makVrf::DtExtendedLabelsManager::setExtendedLabels ( const std::map< int, DtString > &  , bool  sendMessage = true  )

virtual

Sets the extended labels that are available in the system.

Will also send out an interface content message notifying all others of the change

virtual void makVrf::DtExtendedLabelsManager::requestExtendedLabels ( )

virtual

Requests current extended labels.

virtual void makVrf::DtExtendedLabelsManager::processExtendedLabelsOperationMessage ( DtSimMessage *  )

virtual

Called when an extended label operation message is received.

Stores in internal structure and sends signal off that possible changes were received

virtual void makVrf::DtExtendedLabelsManager::setupSymbolDecorations ( )

virtual

virtual bool makVrf::DtExtendedLabelsManager::hasIndex ( int  ) const

virtual

Returns true if the index exists.

virtual void makVrf::DtExtendedLabelsManager::removeAllExtendedLabels ( std::set< std::string > &  ) const

protectedvirtual

Removes all extended label symbol decorations from the given set.

virtual void makVrf::DtExtendedLabelsManager::addAllExtendedLabels ( std::set< std::string > &  ) const

protectedvirtual

Adds all extended label symbol decorations to the given set.

virtual void makVrf::DtExtendedLabelsManager::slot_backendDiscovered ( )

protectedvirtual

virtual int makVrf::DtExtendedLabelsManager::labelMax ( ) const

protectedvirtual

Member Data Documentation

boost::signal<void ()> makVrf::DtExtendedLabelsManager::signal_extendedLabelsChanged

Signal sent on receipt of contents of extended labels and those labels are different than what is currently set internally.

boost::signal<void ()> makVrf::DtExtendedLabelsManager::signal_extendedLabelsSet

Signal when the extended labels are changed via a set or remove – not due to network change.

std::map<int, DtString> makVrf::DtExtendedLabelsManager::myExtendedLabels

protected

std::set<std::string> makVrf::DtExtendedLabelsManager::myCreators

protected

makVrv::DtDe& makVrf::DtExtendedLabelsManager::myDe

protected

bool makVrf::DtExtendedLabelsManager::myInitialized

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrfGuiCore/extendedLabelsManager.h