makVrv::DtDisplayUnitsSettingsManager Class Reference

Manager for the display units settings.

Inheritance diagram for makVrv::DtDisplayUnitsSettingsManager:

Public Member Functions
virtual	~DtDisplayUnitsSettingsManager ()
void	connectInputSignals ()
void	setSuppressMagneticNorthNotationEnabled (bool isEnabled)
bool	isSuppressMagneticNorthNotationEnabled () const
const DtDisplayUnitsConverter &	converter ()
void	slot_quit ()
Setters
void	setCoordinateSystem (DtDisplayUnitsConverter::CoordSys cs)
void	setDisplayUnitUnit (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName, unsigned int unitEnumValue)
void	setDisplayUnitDecimals (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName, unsigned int decimals)
Setting persistence methods
virtual void	setFromRecord (const makArchives::DtDisplayUnitsSettingsRecord &rec)
Public Member Functions inherited from makVrv::DtBaseSharedSettingsManager< makArchives::DtDisplayUnitsSettingsRecord, DtSharedDisplayUnitsSettings >
	DtBaseSharedSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
virtual	~DtBaseSharedSettingsManager ()
virtual void	initializeBackup ()
virtual void	getRecord (makArchives::DtDisplayUnitsSettingsRecord &record) const
virtual bool	getOverriddenFactoryRecord (makArchives::DtDisplayUnitsSettingsRecord &record) const
Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtDisplayUnitsSettingsRecord >
	DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
virtual	~DtCommonBaseSettingsManager ()
virtual void	autoSaveIfNecessary ()
virtual void	setAutoSave (bool doit)
virtual bool	autoSave () const
virtual void	setUseDefaultSettingsRecord (bool useit)
virtual bool	useDefaultSettingsRecord () const
virtual DtDeSettings *	settings ()
virtual const DtDeSettings *	settings () const
virtual DtSettingsBackup *	settingsBackup ()
virtual const DtSettingsBackup *	settingsBackup () const
virtual void	loadDefaults ()
virtual void	saveDefaultSettings ()
virtual void	loadDefaultSettings (bool loadOnlyFactorySettings)
virtual void	importSettings (const std::string &filePath)
virtual void	exportSettings (const std::string &filePath) const
virtual void	getSplitRecord (std::vector< makArchives::DtDisplayUnitsSettingsRecord > &rec, std::vector< std::string > &fileNames)
virtual void	addRecords (makArchives::DtDisplayUnitsSettingsRecord &rec, makArchives::DtDisplayUnitsSettingsRecord &combinedRec)
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtDisplayUnitsSettingsManager &	instance (DtDe &de)

Protected Member Functions
	DtDisplayUnitsSettingsManager (DtDe &de)
virtual void	slot_initializeSynchronizer ()
virtual void	slot_displayEngineAdded (const DtDeRecord &deRec)
virtual void	slot_backupRestored (const DtSettingsBackup *s)

Protected Attributes
DtDisplayUnitsConverter *	myDisplayUnitsConverter
DtDisplayUnitsSettingsSynchronizerAgent *	mySettingsSynchronizer
Protected Attributes inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtDisplayUnitsSettingsRecord >
DtSignalConnectionManager	myConnections
std::string	myName
std::string	myExtension
std::string	myDisplayName
bool	myUseDefaultSettingsRecordFlag
bool	myAutoSaveFlag
DtSettingsBackup *	mySettingsBackup
DtDe &	myDe

Friends
template<typename ManagerClass >
ManagerClass &	defaultManagerInstanceFunction (DtDe &, bool)
template<typename ManagerClass >
void	defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *)

Additional Inherited Members
Protected Types inherited from makVrv::DtBaseSharedSettingsManager< makArchives::DtDisplayUnitsSettingsRecord, DtSharedDisplayUnitsSettings >
typedef DtSharedRecordSettingsBackup < DtSharedDisplayUnitsSettings, makArchives::DtDisplayUnitsSettingsRecord >	SharedRecordBackupType

Constructor & Destructor Documentation

virtual makVrv::DtDisplayUnitsSettingsManager::~DtDisplayUnitsSettingsManager ( )

virtual

DTOR.

makVrv::DtDisplayUnitsSettingsManager::DtDisplayUnitsSettingsManager ( DtDe &  de )

protected

Protected CTOR ( use instance(..) )

Member Function Documentation

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

static

Get an instance of the settings manager.

void makVrv::DtDisplayUnitsSettingsManager::connectInputSignals

(

)

Connect to signal indicating settings have been backed up.

void makVrv::DtDisplayUnitsSettingsManager::setCoordinateSystem

(

DtDisplayUnitsConverter::CoordSys

cs

)

Set the Coordinate System display unit in the 'Application' collection Similar to calling: setDisplayUnitUnit(theApplicationDisplayUnitCollectionName, theCoordinateSystemDisplayUnitName, cs) but uses DtSharedDisplayUnitsSettings::setCoordinateSystem instead of DtSharedDisplayUnitsSettings::setDisplayUnitUnit which has slightly different behavior.

void makVrv::DtDisplayUnitsSettingsManager::setDisplayUnitUnit	(	const DtUnicode &	displayUnitCollectionName,
		const DtUnicode &	displayUnitName,
		unsigned int	unitEnumValue
	)

Set the unit of measurement used for a display unit.

Parameters

displayUnitCollectionName	The name of the collection the display unit is in
displayUnitName	The name of the display unit of interest
unitEnumValue	The unsigned integer value that corresponds to a unit of measurement in a specific Units enumeration, e.g. DtDisplayUnitsSettingsRecord::RotVelocityUnits.

void makVrv::DtDisplayUnitsSettingsManager::setDisplayUnitDecimals	(	const DtUnicode &	displayUnitCollectionName,
		const DtUnicode &	displayUnitName,
		unsigned int	decimals
	)

Set the unit of measurement used for a display unit.

Parameters

displayUnitCollectionName	The name of the collection the display unit is in
displayUnitName	The name of the display unit of interest
decimals	The number of decimal places to use for a given display unit

virtual void makVrv::DtDisplayUnitsSettingsManager::setFromRecord ( const makArchives::DtDisplayUnitsSettingsRecord &  rec )

virtual

Use the settings from the given settings record. Overridden to perform some validation on the settings in the record.

Reimplemented from makVrv::DtBaseSharedSettingsManager< makArchives::DtDisplayUnitsSettingsRecord, DtSharedDisplayUnitsSettings >.

void makVrv::DtDisplayUnitsSettingsManager::setSuppressMagneticNorthNotationEnabled

(

bool

isEnabled

)

Set whether or not to suppress the Heading Notation when using Magnetic North.

Parameters

isEnabled

Whether or not to suppress Magnetic North Heading Notation

bool makVrv::DtDisplayUnitsSettingsManager::isSuppressMagneticNorthNotationEnabled

(

)

const

Get whether or not to suppress the Heading Notation when using Magnetic North.

Returns

Whether or not to suppress Magnetic North Heading Notation

const DtDisplayUnitsConverter& makVrv::DtDisplayUnitsSettingsManager::converter

(

)

Returns the manager's internal converter.

void makVrv::DtDisplayUnitsSettingsManager::slot_quit

(

)

For shutting down the DtDisplayUnitsSettingsManager agents before the de shuts down the agent manager.

virtual void makVrv::DtDisplayUnitsSettingsManager::slot_initializeSynchronizer ( )

protectedvirtual

Initializes the synchronizer agent to keep RDE settings in sync. Instantiates a synchronizer (DtDisplayUnitsSettingsSynchronizerAgent) to keep remote De's display units settings manager's in sync with the master De's settings manager. Also connects to the IG communicator's clientAdded signal so the synchronizer can be reinitialized when a new De is connected.

virtual void makVrv::DtDisplayUnitsSettingsManager::slot_displayEngineAdded ( const DtDeRecord &  deRec )

protectedvirtual

Receives notification that a new De has been connected. Re-initializes the synchronizer so the new De's settings manager can be kept up to date.

See Also

slot_initializeSynchronizer()

virtual void makVrv::DtDisplayUnitsSettingsManager::slot_backupRestored ( const DtSettingsBackup *  s )

protectedvirtual

Called when the setting is restored, save out if auto save is true.

Friends And Related Function Documentation

template<typename ManagerClass >

ManagerClass& defaultManagerInstanceFunction ( DtDe &  de, bool  allowedInSlave  )

friend

Befriend the manager instance functions for instance retrieval/creation.

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

class Manager
{
public:
   static Manager& instance(DtDe& de);
   void loadDefaults();
protected:
   template <typename ManagerClass>
   friend ManagerClass& defaultManagerInstanceFunction(DtDe& de, bool);
   template <typename ManagerClass>
   friend void defaultManagerRegisterInstanceFunction(DtDe& de, ManagerClass* mgr)
   Manager(DtDe&);
   DtSignalConnectionManager myConnections;
};

Then simply in the implementation of instance call defaultManagerInstanceFunction with the de object and return the return value.

Manager& Manager::instance(DtDe& de)
{
   return defaultManagerInstanceFunction<Manager>(de);
}

template<typename ManagerClass >

void defaultManagerRegisterInstanceFunction ( DtDe &  de, ManagerClass *  mgr  )

friend

Befriend the manager instance functions for instance retrieval/creation.

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

static void Manager::registerInstance(DtDe& de, Manager* mgr)
{
   defaultManagerRegisterInstanceFunction(de,mgr);
}
...else where call.
// Assuming class NewManager : public Manager
Manager::registerInstance(de,new NewManager(de));

Member Data Documentation

DtDisplayUnitsConverter* makVrv::DtDisplayUnitsSettingsManager::myDisplayUnitsConverter

protected

DtDisplayUnitsSettingsSynchronizerAgent* makVrv::DtDisplayUnitsSettingsManager::mySettingsSynchronizer

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtDisplayUnitsSettingsManager.h