VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends
makVrv::DtChannelKeywordObjectManager Class Reference

An object that manages 2D Channel-specific keyword-specified objects.

Inheritance diagram for makVrv::DtChannelKeywordObjectManager:
Inheritance graph
[legend]

Public Types

using ObjectMap = std::unordered_map< std::string, DtChannelKeywordObject * >
 
using ChannelMap = std::unordered_map< std::string, ObjectMap >
 

Public Member Functions

virtual ~DtChannelKeywordObjectManager ()
 
const ChannelMapchannelMap () const
 
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 
virtual ~DtVirtualBaseClass ()
 

Static Public Member Functions

static
DtChannelKeywordObjectManager
instance (DtDe &de)
 

Protected Types

using ChannelKeyList = std::vector< std::string >
 
using WindowMap = std::unordered_map< std::string, ChannelKeyList >
 

Protected Member Functions

virtual void processChannelConfiguration (const std::string &deName, const std::string &winName, const DtChannelConfiguration &config)
 
virtual std::string makeChannelKey (const std::string &deName, const std::string &winName, const std::string &channelName)
 
virtual std::string makeWindowKey (const std::string &deName, const std::string &winName)
 
virtual void addChannelKeywordObject (const std::string &channelKey, const std::string &keyword, DtChannelKeywordObject *keywordObject)
 
virtual void removeChannelKeywordObject (const std::string &channelKey, const std::string &keyword)
 
virtual void removeAllChannelKeywordObjectsFromChannel (const std::string &channelKey)
 
void addToWindowMap (const std::string &windowKey, const std::string &channelKey)
 
void removeFromWindowMap (const std::string &windowKey, const std::string &channelKey)
 
 DtChannelKeywordObjectManager (DtDe &de)
 
virtual void slot_channelCreated (DtChannelManager *, DtChannel *)
 
virtual void slot_channelToBeDestroyed (const std::string &deName, const std::string &winName, const std::string &channelName)
 
virtual void slot_channelConfigurationAdded (const std::string &deName, const std::string &winName, const DtChannelConfiguration &config)
 
virtual void slot_displayConfigurationRealized (const std::string &igName, const std::string &displayName)
 
virtual void slot_displayToBeDestroyed (const std::string &displayName)
 
virtual void slot_channelConfigurationModified (const std::string &deName, const std::string &winName, const std::string &oldChannelName, const DtChannelConfiguration &config)
 
virtual void slot_windowConfigurationModified (const std::string &deName, const std::string &oldWindowName, const DtWindowConfiguration &config)
 

Static Protected Member Functions

static std::string getChannelNameFromChannelKey (const std::string &channelKey)
 

Protected Attributes

DtDemyDe
 
DtSignalConnectionManager myConnections
 
ChannelMap myChannelMap
 
WindowMap myWindowMap
 

Friends

class DtChannelKeywordObjectManagerCreator
 

Member Typedef Documentation

This is a map of channel keyword objects indexed by keyword name. each channel may have such a map.

using makVrv::DtChannelKeywordObjectManager::ChannelMap = std::unordered_map<std::string, ObjectMap>

This is a map of ObjectMaps, indexed by ChannelName :: WindowName :: DisplayName.

using makVrv::DtChannelKeywordObjectManager::ChannelKeyList = std::vector<std::string>
protected

This is a map of channel key lists indexed by window key Given a deName/windowName, we can get all the channel keys for channels in that window that have compasses.

using makVrv::DtChannelKeywordObjectManager::WindowMap = std::unordered_map<std::string, ChannelKeyList>
protected

Constructor & Destructor Documentation

virtual makVrv::DtChannelKeywordObjectManager::~DtChannelKeywordObjectManager ( )
virtual

DTOR.

makVrv::DtChannelKeywordObjectManager::DtChannelKeywordObjectManager ( DtDe de)
protected

CTOR Protected, use creator.

Member Function Documentation

static DtChannelKeywordObjectManager& makVrv::DtChannelKeywordObjectManager::instance ( DtDe de)
static

Get an instance of the DtChannelKeywordObjectManager. This will be called by DtScene2D when in master mode to ensure the existence of manager.

const ChannelMap& makVrv::DtChannelKeywordObjectManager::channelMap ( ) const

Make the channelMap available.

virtual void makVrv::DtChannelKeywordObjectManager::slot_channelCreated ( DtChannelManager ,
DtChannel  
)
protectedvirtual

Signal Slots.

virtual void makVrv::DtChannelKeywordObjectManager::slot_channelToBeDestroyed ( const std::string &  deName,
const std::string &  winName,
const std::string &  channelName 
)
protectedvirtual

Signal Slots.

virtual void makVrv::DtChannelKeywordObjectManager::slot_channelConfigurationAdded ( const std::string &  deName,
const std::string &  winName,
const DtChannelConfiguration config 
)
protectedvirtual

Signal Slots.

virtual void makVrv::DtChannelKeywordObjectManager::slot_displayConfigurationRealized ( const std::string &  igName,
const std::string &  displayName 
)
protectedvirtual

Signal Slots.

virtual void makVrv::DtChannelKeywordObjectManager::slot_displayToBeDestroyed ( const std::string &  displayName)
protectedvirtual

Signal Slots.

virtual void makVrv::DtChannelKeywordObjectManager::slot_channelConfigurationModified ( const std::string &  deName,
const std::string &  winName,
const std::string &  oldChannelName,
const DtChannelConfiguration config 
)
protectedvirtual

Signal Slots.

virtual void makVrv::DtChannelKeywordObjectManager::slot_windowConfigurationModified ( const std::string &  deName,
const std::string &  oldWindowName,
const DtWindowConfiguration config 
)
protectedvirtual

Signal Slots.

virtual void makVrv::DtChannelKeywordObjectManager::processChannelConfiguration ( const std::string &  deName,
const std::string &  winName,
const DtChannelConfiguration config 
)
protectedvirtual

Helper methods we may get deName, windowName, and configuration in different ways, but once we have them, call this.

virtual std::string makVrv::DtChannelKeywordObjectManager::makeChannelKey ( const std::string &  deName,
const std::string &  winName,
const std::string &  channelName 
)
protectedvirtual
virtual std::string makVrv::DtChannelKeywordObjectManager::makeWindowKey ( const std::string &  deName,
const std::string &  winName 
)
protectedvirtual
virtual void makVrv::DtChannelKeywordObjectManager::addChannelKeywordObject ( const std::string &  channelKey,
const std::string &  keyword,
DtChannelKeywordObject keywordObject 
)
protectedvirtual
virtual void makVrv::DtChannelKeywordObjectManager::removeChannelKeywordObject ( const std::string &  channelKey,
const std::string &  keyword 
)
protectedvirtual
virtual void makVrv::DtChannelKeywordObjectManager::removeAllChannelKeywordObjectsFromChannel ( const std::string &  channelKey)
protectedvirtual

Special case; can't use removeChannelKeywordObjects() because we're iterating over the object map, so this one method removes them all.

void makVrv::DtChannelKeywordObjectManager::addToWindowMap ( const std::string &  windowKey,
const std::string &  channelKey 
)
protected
void makVrv::DtChannelKeywordObjectManager::removeFromWindowMap ( const std::string &  windowKey,
const std::string &  channelKey 
)
protected
static std::string makVrv::DtChannelKeywordObjectManager::getChannelNameFromChannelKey ( const std::string &  channelKey)
staticprotected

Friends And Related Function Documentation

Specify the Creator class as a friend.

Member Data Documentation

DtDe& makVrv::DtChannelKeywordObjectManager::myDe
protected
DtSignalConnectionManager makVrv::DtChannelKeywordObjectManager::myConnections
protected
ChannelMap makVrv::DtChannelKeywordObjectManager::myChannelMap
protected

This map provides a pointer to CompassMap given a ChannelName :: WindowName :: DisplayName string. The CompassMap can then provide a pointer to a compass based on keyword.

WindowMap makVrv::DtChannelKeywordObjectManager::myWindowMap
protected

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

Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)