Manager for the display units settings. More...

Inheritance diagram for makVrv::DtDisplayUnitsSettingsManager:

Public Member Functions
virtual	~DtDisplayUnitsSettingsManager ()
	DTOR.
void	connectInputSignals ()
	Connect to signal indicating settings have been backed up.
DtDisplayUnitsConverter &	converter ()
	Returns the manager's internal converter.
Setters
void	setCoordinateSystem (DtDisplayUnitsConverter::CoordSys cs)
void	setDistanceUnits (DtDisplayUnitsConverter::DistanceUnits distUnits)
void	setAltitudeUnits (DtDisplayUnitsConverter::DistanceUnits altUnits)
void	setVelocityUnits (DtDisplayUnitsConverter::VelocityUnits velocityUnits)
void	setOrientationUnits (DtDisplayUnitsConverter::OrientationUnits oriUnits)
void	setAccelerationUnits (DtDisplayUnitsConverter::AccelerationUnits accelUnits)
void	setRotationalVelocityUnits (DtDisplayUnitsConverter::RotVelocityUnits wUnits)
void	setCoordinateSystemDecimals (DtDisplayUnitsConverter::CoordSys cs, int decimals)
void	setDistanceUnitDecimals (DtDisplayUnitsConverter::DistanceUnits distUnit, int decimals)
void	setAltitudeUnitDecimals (DtDisplayUnitsConverter::DistanceUnits altUnit, int decimals)
void	setVelocityUnitDecimals (DtDisplayUnitsConverter::VelocityUnits velocityUnit, int decimals)
void	setOrientationUnitDecimals (DtDisplayUnitsConverter::OrientationUnits oriUnit, int decimals)
void	setAccelerationUnitDecimals (DtDisplayUnitsConverter::AccelerationUnits accelUnit, int decimals)
void	setRotationalVelocityUnitDecimals (DtDisplayUnitsConverter::RotVelocityUnits wUnit, int decimals)
Setting persistence methods
virtual void	setFromRecord (const makArchives::DtDisplayUnitsSettingsRecord &rec)
	Use the settings from the given settings record.
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)
	CTOR.
virtual	~DtBaseSharedSettingsManager ()
	Virtual DTOR.
virtual void	initializeBackup ()
	Creates a backup of the settings' current state.
virtual void	getRecord (makArchives::DtDisplayUnitsSettingsRecord &record) const
	Store the current settings' state in the given record.
Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtDisplayUnitsSettingsRecord >
	DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
	CTOR The name, displayName, and extension parameters are used for creating the settings object (DtDeSettings) and backup, and for constructing the filename when readin/writing the records to disk.
virtual	~DtCommonBaseSettingsManager ()
	Virtual DTOR.
virtual void	autoSaveIfNecessary ()
	Saves the current settings as defaults if autosave is enabled.
virtual void	setAutoSave (bool doit)
	Sets whether autosave is enabled for the settings manager.
virtual bool	autoSave () const
	Gets whether autosave is enabled for the settings manager.
virtual void	setUseDefaultSettingsRecord (bool useit)
	Sets whether setting initialization should check for a default record.
virtual bool	useDefaultSettingsRecord () const
	Gets whether setting initialization should check for a default record.
virtual DtDeSettings *	settings ()
	Accessor for the manager's DtDeSettings object.
virtual const DtDeSettings *	settings () const
	Accessor for the manager's DtDeSettings object (const).
virtual DtSettingsBackup *	settingsBackup ()
	Accessor for the manager's settings backup.
virtual const DtSettingsBackup *	settingsBackup () const
	Accessor for the manager's settings backup (const).
virtual void	loadDefaults ()
	Initializes the settings and creates a backup.
virtual void	saveDefaultSettings ()
	Saves the current settings' state as the default (on disk).
virtual void	loadDefaultSettings (bool loadOnlyFactorySettings)
	Loads the default settings from disk.
virtual void	importSettings (const std::string &filePath)
	Load the settings' state from the given file.
virtual void	exportSettings (const std::string &filePath) const
	Save the current settings' state to the given file.
virtual void	getSplitRecord (std::vector< makArchives::DtDisplayUnitsSettingsRecord > &rec, std::vector< std::string > &fileNames)
	For directory support, split the main record into different sub-records and give them each a file name.
virtual void	addRecords (makArchives::DtDisplayUnitsSettingsRecord &rec, makArchives::DtDisplayUnitsSettingsRecord &combinedRec)
	For directory support, when reading in a directory, add the records from each file to the combined record.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtDisplayUnitsSettingsManager &	instance (DtDe &de)
	Get an instance of the settings manager.

Protected Member Functions
	DtDisplayUnitsSettingsManager (DtDe &de)
	Protected CTOR ( use instance(..) )
virtual void	slot_initializeSynchronizer ()
	Initializes the synchronizer agent to keep RDE settings in sync.
virtual void	slot_displayEngineAdded (const DtDeRecord &deRec)
	Receives notification that a new De has been connected.
virtual void	slot_backupRestored (const DtSettingsBackup *s)
	Called when the setting is restored, save out if auto save is true.

Protected Attributes
DtDisplayUnitsConverter *	myDisplayUnitsConverter
DtDisplayUnitsSettingsSynchronizerAgent *	mySettingsSynchronizer

Friends
template<typename ManagerClass >
ManagerClass &	defaultManagerInstanceFunction (DtDe &, bool)
	Befriend the manager instance functions for instance retreival/creation.
template<typename ManagerClass >
void	defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *)
	Befriend the manager instance functions for instance retreival/creation.

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

Detailed Description

Manager for the display units settings.

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 )

void makVrv::DtDisplayUnitsSettingsManager::setDistanceUnits ( DtDisplayUnitsConverter::DistanceUnits distUnits )

void makVrv::DtDisplayUnitsSettingsManager::setAltitudeUnits ( DtDisplayUnitsConverter::DistanceUnits altUnits )

void makVrv::DtDisplayUnitsSettingsManager::setVelocityUnits ( DtDisplayUnitsConverter::VelocityUnits velocityUnits )

void makVrv::DtDisplayUnitsSettingsManager::setOrientationUnits ( DtDisplayUnitsConverter::OrientationUnits oriUnits )

void makVrv::DtDisplayUnitsSettingsManager::setAccelerationUnits ( DtDisplayUnitsConverter::AccelerationUnits accelUnits )

void makVrv::DtDisplayUnitsSettingsManager::setRotationalVelocityUnits ( DtDisplayUnitsConverter::RotVelocityUnits wUnits )

void makVrv::DtDisplayUnitsSettingsManager::setCoordinateSystemDecimals	(	DtDisplayUnitsConverter::CoordSys	cs,
		int	decimals
	)

void makVrv::DtDisplayUnitsSettingsManager::setDistanceUnitDecimals	(	DtDisplayUnitsConverter::DistanceUnits	distUnit,
		int	decimals
	)

void makVrv::DtDisplayUnitsSettingsManager::setAltitudeUnitDecimals	(	DtDisplayUnitsConverter::DistanceUnits	altUnit,
		int	decimals
	)

void makVrv::DtDisplayUnitsSettingsManager::setVelocityUnitDecimals	(	DtDisplayUnitsConverter::VelocityUnits	velocityUnit,
		int	decimals
	)

void makVrv::DtDisplayUnitsSettingsManager::setOrientationUnitDecimals	(	DtDisplayUnitsConverter::OrientationUnits	oriUnit,
		int	decimals
	)

void makVrv::DtDisplayUnitsSettingsManager::setAccelerationUnitDecimals	(	DtDisplayUnitsConverter::AccelerationUnits	accelUnit,
		int	decimals
	)

void makVrv::DtDisplayUnitsSettingsManager::setRotationalVelocityUnitDecimals	(	DtDisplayUnitsConverter::RotVelocityUnits	wUnit,
		int	decimals
	)

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 >.

DtDisplayUnitsConverter& makVrv::DtDisplayUnitsSettingsManager::converter ( )

Returns the manager's internal converter.

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 retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

  Manager requirements:
  1) Static instance function
  2) Protected DtSignalConnectionManager named myConnections.
  3) Member functioned called loadDefaults which takes no arguments.
     and loads the default settings of the manager or factory from disk.
  4) define defaultManagerInstanceFunction as friend.
  5) define defaultManagerRegisterInstanceFunction as friend (see below).
  5) Protected Constructor which only takes a DtDe reference.
  @code

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.
  @code

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 retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

  @code

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:

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtDisplayUnitsSettingsManager.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation