makVrv::DtSharedCigiSettings Class Reference

The shared CIGI settings. This class contains all of the settings, and each has a name. The current settings should be set, and then all of the add/set/remove/find methods will act on the current settings. This class also emits thread-safe signals via the DtCigiSettingsSignaler so that the settings contained within the DtCigiConnection can be updated while running.

Inheritance diagram for makVrv::DtSharedCigiSettings:

Public Types
typedef std::pair < makArchives::DtCigiSettingsRecord *, DtCigiSettingsBackup * >	DtCigiSettingsPair
typedef std::map< std::string, DtCigiSettingsPair >	StringToSettingsMap

Public Member Functions
virtual	~DtSharedCigiSettings ()
virtual void	addCigiSettings (const std::string &settingsName)
virtual void	setCigiSettings (const std::string &settingsName, const makArchives::DtCigiSettingsRecord &record)
virtual void	removeCigiSettings (const std::string &settingsName)
virtual void	setCurrentSettingsName (const std::string &settingsName)
virtual const makArchives::DtCigiSettingsRecord *	currentSettings () const
virtual const std::string &	currentSettingsName () const
virtual makArchives::DtCigiSettingsRecord *	findCigiSettingsByName (const std::string &settingsName)
virtual const makArchives::DtCigiSettingsRecord *	findCigiSettingsByName (const std::string &settingsName) const
virtual bool	definitionInUse (const std::string &def) const
virtual const std::string &	mapEntityModelDefinition (int entType) const
virtual const std::string &	mapEntityModelSchemaName (int entType) const
virtual StringToSettingsMap::const_iterator	begin () const
virtual StringToSettingsMap::const_iterator	end () const
virtual unsigned int	settingsCount () const
virtual const std::string &	findDatabaseFilename (int databaseNumber)
virtual const std::string &	findAnimationName (int animationId)
virtual const std::string &	findActiveRegionName (int regionId)
virtual const std::string &	findLightPointGroupName (int groupId)
virtual const std::string &	findSensorName (int sensorId)
virtual const std::string &	findFontName (int fontId)
virtual const std::string &	findEnvironmentalConditionName (int envId)
virtual const std::vector < std::string > &	componentStrings (makArchives::DtCigiComponentClass compClass) const
virtual const DtSettingsBackup *	settingsBackup (const std::string &name) const
virtual DtSettingsBackup *	settingsBackup (const std::string &name)
virtual void	addModelStateMapping (int cigiId, int stateId)
virtual void	removeModelStateMapping (int cigiId)
virtual void	setArtPartMapping (int entType, int cigiId, int disId)
virtual void	removeArtPartMapping (int entType, int cigiId)
virtual void	addDatabaseMapping (int databaseNumber, const std::string &filename)
virtual void	removeDatabaseMapping (int databaseNumber)
virtual void	addObserverModeMapping (int observerNumber, const std::string &filename)
virtual void	removeObserverModeMapping (int observerNumber)
virtual void	addComponentIdMapping (makArchives::DtCigiComponentClass compClass, int compId, const std::string &compName)
virtual void	removeComponentIdMapping (makArchives::DtCigiComponentClass compClass, int compId)
virtual void	addAnimationMapping (int animationId, const std::string &animationName)
virtual void	removeAnimationMapping (int animationId)
virtual void	addActiveRegionMapping (int regionId, const std::string &regionName)
virtual void	removeActiveRegionMapping (int regionId)
virtual void	addLightPointGroupMapping (int groupId, const std::string &groupName)
virtual void	removeLightPointGroupMapping (int groupId)
virtual void	addSensorMapping (int sensorId, const std::string &sensorName)
virtual void	removeSensorMapping (int sensorId)
virtual void	addFontMapping (int fontId, const std::string &fontName)
virtual void	removeFontMapping (int fontId)
virtual void	addEnvironmentalConditionMapping (int envId, const std::string &envName)
virtual void	removeEnvironmentalConditionMapping (int envId)
virtual void	setEntityTypeModelMapping (int entType, const std::string &modelName, const std::string &schemaName)
virtual void	removeEntityTypeModelMapping (int entType)
virtual bool	remapEntityType (int oldType, int newType)
virtual bool	renameModelDefinition (const std::string &oldName, const std::string &newName, std::vector< std::string > &mappersChanged)
Public Member Functions inherited from makVrv::DtSharedSettings
	DtSharedSettings (const DtSharedSettingsManager &manager)
virtual	~DtSharedSettings ()
boost::shared_mutex &	mutex ()
SafetyKey	safeToEmitSignals ()
void	setCurrentWriteLock (boost::unique_lock< boost::shared_mutex > *currentWriteLock)
virtual const DtSettingsBackup *	settingsBackup () const
virtual DtSettingsBackup *	settingsBackup ()
virtual void	backup ()
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static std::string	className ()

Protected Member Functions
	DtSharedCigiSettings (DtSharedSettingsManager &manager)

Protected Attributes
std::string	myEmptyMapping
StringToSettingsMap	mySettingsByName
std::string	myCurrentSettingsName
makArchives::DtCigiSettingsRecord *	myCurrentSettings
std::vector< std::string >	myEntityComponentStrings
std::vector< std::string >	myViewComponentStrings
std::vector< std::string >	mySystemComponentStrings
std::vector< std::string >	myRegionalSeaSurfaceComponentStrings
std::vector< std::string >	myGlobalTerrainSurfaceComponent
std::vector< std::string >	mySensorComponentStrings
std::vector< std::string >	myAtmosphereComponentStrings

Friends
class	DtReadSettingsLock< DtSharedCigiSettings >
class	DtWriteSettingsLock< DtSharedCigiSettings >
class	DtSharedSettingsManager

Member Typedef Documentation

typedef std::pair<makArchives::DtCigiSettingsRecord*, DtCigiSettingsBackup*> makVrv::DtSharedCigiSettings::DtCigiSettingsPair

typedef std::map<std::string, DtCigiSettingsPair> makVrv::DtSharedCigiSettings::StringToSettingsMap

Constructor & Destructor Documentation

virtual makVrv::DtSharedCigiSettings::~DtSharedCigiSettings ( )

virtual

Destructor.

makVrv::DtSharedCigiSettings::DtSharedCigiSettings ( DtSharedSettingsManager &  manager )

protected

CTOR.

Member Function Documentation

static std::string makVrv::DtSharedCigiSettings::className ( )

static

Get an instance of the settings object. Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.

virtual void makVrv::DtSharedCigiSettings::addCigiSettings ( const std::string &  settingsName )

virtual

Create new settings with the specified name.

virtual void makVrv::DtSharedCigiSettings::setCigiSettings ( const std::string &  settingsName, const makArchives::DtCigiSettingsRecord &  record  )

virtual

Set the specified settings with the name. Creates the settings if they do not exist, and overwrites the settings if they do.

virtual void makVrv::DtSharedCigiSettings::removeCigiSettings ( const std::string &  settingsName )

virtual

Remove the settings with the specified name.

virtual void makVrv::DtSharedCigiSettings::setCurrentSettingsName ( const std::string &  settingsName )

virtual

Sets the name of the current settings being used.

virtual const makArchives::DtCigiSettingsRecord* makVrv::DtSharedCigiSettings::currentSettings ( ) const

virtual

Returns the current settings.

virtual const std::string& makVrv::DtSharedCigiSettings::currentSettingsName ( ) const

virtual

Returns the name of the current settings.

virtual makArchives::DtCigiSettingsRecord* makVrv::DtSharedCigiSettings::findCigiSettingsByName ( const std::string &  settingsName )

virtual

Returns a pointer of the settings of the given name.

Returns

0 if none exists.

virtual const makArchives::DtCigiSettingsRecord* makVrv::DtSharedCigiSettings::findCigiSettingsByName ( const std::string &  settingsName ) const

virtual

Const version of the above method.

virtual bool makVrv::DtSharedCigiSettings::definitionInUse ( const std::string &  def ) const

virtual

Returns true if any of the mappers use the given definition.

virtual const std::string& makVrv::DtSharedCigiSettings::mapEntityModelDefinition ( int  entType ) const

virtual

Returns the model definition that the CIGI entity type maps to for the particular settings.

Returns

The empty string if none exists.

virtual const std::string& makVrv::DtSharedCigiSettings::mapEntityModelSchemaName ( int  entType ) const

virtual

Returns the schema type that the CIGI entity type maps to for the particular settings.

Returns

The empty string if none exists.

virtual StringToSettingsMap::const_iterator makVrv::DtSharedCigiSettings::begin ( ) const

virtual

Iterators that point to the beginning and end of the settings map.

virtual StringToSettingsMap::const_iterator makVrv::DtSharedCigiSettings::end ( ) const

virtual

virtual unsigned int makVrv::DtSharedCigiSettings::settingsCount ( ) const

virtual

Returns the number of settings contained in the settings map.

virtual const std::string& makVrv::DtSharedCigiSettings::findDatabaseFilename ( int  databaseNumber )

virtual

Returns the filename that corresponds to the database number.

Returns

The empty string if no mapping is found.

virtual const std::string& makVrv::DtSharedCigiSettings::findAnimationName ( int  animationId )

virtual

Returns the animation that corresponds to the specified ID.

Returns

The empty string if the mapping is not found.

virtual const std::string& makVrv::DtSharedCigiSettings::findActiveRegionName ( int  regionId )

virtual

Returns the active sensor region that corresponds to the specified ID.

Returns

The empty string if the mapping is not found.

virtual const std::string& makVrv::DtSharedCigiSettings::findLightPointGroupName ( int  groupId )

virtual

Returns the light point group that corresponds to the specified ID.

Returns

The empty string if the mapping is not found.

virtual const std::string& makVrv::DtSharedCigiSettings::findSensorName ( int  sensorId )

virtual

Returns the sensor name that corresponds to the specified ID.

Returns

The empty string if the mapping is not found.

virtual const std::string& makVrv::DtSharedCigiSettings::findFontName ( int  fontId )

virtual

Returns the font name that corresponds to the specified ID.

Returns

The empty string if the mapping is not found.

virtual const std::string& makVrv::DtSharedCigiSettings::findEnvironmentalConditionName ( int  envId )

virtual

Returns the environmetnal condition name that corresponds to the specified ID.

Returns

The empty string if the mapping is not found.

virtual const std::vector<std::string>& makVrv::DtSharedCigiSettings::componentStrings ( makArchives::DtCigiComponentClass  compClass ) const

virtual

Returns a list of all the possible components for the specified component class.

virtual const DtSettingsBackup* makVrv::DtSharedCigiSettings::settingsBackup ( const std::string &  name ) const

virtual

Returns a backup object by cigi settings name.

virtual DtSettingsBackup* makVrv::DtSharedCigiSettings::settingsBackup ( const std::string &  name )

virtual

virtual void makVrv::DtSharedCigiSettings::addModelStateMapping ( int  cigiId, int  stateId  )

virtual

Adds a CIGI Component ID to state ID mapping.

virtual void makVrv::DtSharedCigiSettings::removeModelStateMapping ( int  cigiId )

virtual

Removes the CIGI Component ID to State ID mapping.

virtual void makVrv::DtSharedCigiSettings::setArtPartMapping ( int  entType, int  cigiId, int  disId  )

virtual

Sets the mapping from CIGI ID to DIS ID for the specified entity type.

virtual void makVrv::DtSharedCigiSettings::removeArtPartMapping ( int  entType, int  cigiId  )

virtual

Removes the articulated part mapping for the particular entity type.

virtual void makVrv::DtSharedCigiSettings::addDatabaseMapping ( int  databaseNumber, const std::string &  filename  )

virtual

Adds a database number to filename mapping.

virtual void makVrv::DtSharedCigiSettings::removeDatabaseMapping ( int  databaseNumber )

virtual

Removes the database mapping with the specified database number.

virtual void makVrv::DtSharedCigiSettings::addObserverModeMapping ( int  observerNumber, const std::string &  filename  )

virtual

Adds an observer mode number to observer name mapping.

virtual void makVrv::DtSharedCigiSettings::removeObserverModeMapping ( int  observerNumber )

virtual

Removes the observer mode mapping with the specified observer mode number.

virtual void makVrv::DtSharedCigiSettings::addComponentIdMapping ( makArchives::DtCigiComponentClass  compClass, int  compId, const std::string &  compName  )

virtual

Adds a mapping of component ID to name for the particular component class.

virtual void makVrv::DtSharedCigiSettings::removeComponentIdMapping ( makArchives::DtCigiComponentClass  compClass, int  compId  )

virtual

Removes the component ID mapping with the specified ID for the particular component class.

virtual void makVrv::DtSharedCigiSettings::addAnimationMapping ( int  animationId, const std::string &  animationName  )

virtual

Adds an animation ID to name mapping.

virtual void makVrv::DtSharedCigiSettings::removeAnimationMapping ( int  animationId )

virtual

Removes the animation mapping with the specified ID.

virtual void makVrv::DtSharedCigiSettings::addActiveRegionMapping ( int  regionId, const std::string &  regionName  )

virtual

Adds an active sensor region ID to name mapping.

virtual void makVrv::DtSharedCigiSettings::removeActiveRegionMapping ( int  regionId )

virtual

Removes the active sensor region name mapping with the specified ID.

virtual void makVrv::DtSharedCigiSettings::addLightPointGroupMapping ( int  groupId, const std::string &  groupName  )

virtual

Adds an light point group to name mapping.

virtual void makVrv::DtSharedCigiSettings::removeLightPointGroupMapping ( int  groupId )

virtual

Removes thelight point grou name mapping with the specified ID.

virtual void makVrv::DtSharedCigiSettings::addSensorMapping ( int  sensorId, const std::string &  sensorName  )

virtual

Adds an sensor ID to name mapping.

virtual void makVrv::DtSharedCigiSettings::removeSensorMapping ( int  sensorId )

virtual

Removes the sensor name mapping with the specified ID.

virtual void makVrv::DtSharedCigiSettings::addFontMapping ( int  fontId, const std::string &  fontName  )

virtual

Adds a fond ID to name mapping.

virtual void makVrv::DtSharedCigiSettings::removeFontMapping ( int  fontId )

virtual

Removes the Font name mapping with the specified ID.

virtual void makVrv::DtSharedCigiSettings::addEnvironmentalConditionMapping ( int  envId, const std::string &  envName  )

virtual

Adds a environmental condition ID to name mapping.

virtual void makVrv::DtSharedCigiSettings::removeEnvironmentalConditionMapping ( int  envId )

virtual

Removes the environmental condition name mapping with the specified ID.

virtual void makVrv::DtSharedCigiSettings::setEntityTypeModelMapping ( int  entType, const std::string &  modelName, const std::string &  schemaName  )

virtual

Sets the model definition and schema type for the CIGI entity type.

virtual void makVrv::DtSharedCigiSettings::removeEntityTypeModelMapping ( int  entType )

virtual

Removes the entity type mapping for the CIGI entity type.

virtual bool makVrv::DtSharedCigiSettings::remapEntityType ( int  oldType, int  newType  )

virtual

Changes the entity type in the mapping from oldType to newType.

virtual bool makVrv::DtSharedCigiSettings::renameModelDefinition ( const std::string &  oldName, const std::string &  newName, std::vector< std::string > &  mappersChanged  )

virtual

Goes through all the mappers and renames the model definition to the new name. Returns true if any mappers have changed and puts the changed mappers in the vector.

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSharedCigiSettings >

friend

Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.

friend class DtWriteSettingsLock< DtSharedCigiSettings >

friend

friend class DtSharedSettingsManager

friend

Member Data Documentation

std::string makVrv::DtSharedCigiSettings::myEmptyMapping

protected

Empty string, for returning the reference which will always be empty.

StringToSettingsMap makVrv::DtSharedCigiSettings::mySettingsByName

protected

std::string makVrv::DtSharedCigiSettings::myCurrentSettingsName

protected

makArchives::DtCigiSettingsRecord* makVrv::DtSharedCigiSettings::myCurrentSettings

protected

std::vector<std::string> makVrv::DtSharedCigiSettings::myEntityComponentStrings

protected

std::vector<std::string> makVrv::DtSharedCigiSettings::myViewComponentStrings

protected

std::vector<std::string> makVrv::DtSharedCigiSettings::mySystemComponentStrings

protected

std::vector<std::string> makVrv::DtSharedCigiSettings::myRegionalSeaSurfaceComponentStrings

protected

std::vector<std::string> makVrv::DtSharedCigiSettings::myGlobalTerrainSurfaceComponent

protected

std::vector<std::string> makVrv::DtSharedCigiSettings::mySensorComponentStrings

protected

std::vector<std::string> makVrv::DtSharedCigiSettings::myAtmosphereComponentStrings

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCigi/DtSharedCigiSettings.h