makVrv::DtInterestManagementSettingsManager Class Reference

Manager for interest management (DDM) settings. More...

Inheritance diagram for makVrv::DtInterestManagementSettingsManager:

Public Member Functions
virtual	~DtInterestManagementSettingsManager ()
	DTOR. More...
virtual void	updateInterestManagementSettings ()
	Forces a reset of all current interest management settings to what they currently are to force signals to be sent. More...
Setting Getters/Setters
virtual int	ddmRegionSize () const
	Gets the DDM region size to use. More...
virtual void	setDdmRegionSize (int size)
	Sets the DDM region size to use. More...
virtual int	regionUpdateThreshold () const
	Gets the threshold for region updates. More...
virtual void	setRegionUpdateThreshold (int percentage)
	Sets the threshold for region updates. More...
virtual bool	altitudeThresholdEnabled () const
	Gets whether the altitude threshold for DDM regions is enabled. More...
virtual void	setAltitudeThresholdEnabled (bool enabled)
	Sets whether the altitude threshold for DDM regions is enabled. More...
virtual int	altitudeThreshold () const
	Gets the altitude threshold for DDM regions. More...
virtual void	setAltitudeThreshold (int threshold)
	Sets the altitude threshold for DDM regions. More...
Public Member Functions inherited from makVrv::DtBaseSharedSettingsManager< makArchives::DtInterestManagementRecord, DtSharedInterestManagementSettings >
	DtBaseSharedSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
	CTOR. More...
virtual	~DtBaseSharedSettingsManager ()
	Virtual DTOR. More...
virtual void	initializeBackup ()
	Creates a backup of the settings' current state. More...
virtual void	setFromRecord (const makArchives::DtInterestManagementRecord &record)
	Set the current settings' state from the given record. More...
virtual void	getRecord (makArchives::DtInterestManagementRecord &record) const
	Store the current settings' state in the given record. More...
Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtInterestManagementRecord >
	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. More...
virtual	~DtCommonBaseSettingsManager ()
	Virtual DTOR. More...
virtual void	autoSaveIfNecessary ()
	Saves the current settings as defaults if autosave is enabled. More...
virtual void	setAutoSave (bool doit)
	Sets whether autosave is enabled for the settings manager. More...
virtual bool	autoSave () const
	Gets whether autosave is enabled for the settings manager. More...
virtual void	setUseDefaultSettingsRecord (bool useit)
	Sets whether setting initialization should check for a default record. More...
virtual bool	useDefaultSettingsRecord () const
	Gets whether setting initialization should check for a default record. More...
virtual DtDeSettings *	settings ()
	Accessor for the manager's DtDeSettings object. More...
virtual const DtDeSettings *	settings () const
	Accessor for the manager's DtDeSettings object (const). More...
virtual DtSettingsBackup *	settingsBackup ()
	Accessor for the manager's settings backup. More...
virtual const DtSettingsBackup *	settingsBackup () const
	Accessor for the manager's settings backup (const). More...
virtual void	loadDefaults ()
	Initializes the settings and creates a backup. More...
virtual void	saveDefaultSettings ()
	Saves the current settings' state as the default (on disk). More...
virtual void	loadDefaultSettings (bool loadOnlyFactorySettings)
	Loads the default settings from disk. More...
virtual void	importSettings (const std::string &filePath)
	Load the settings' state from the given file. More...
virtual void	exportSettings (const std::string &filePath) const
	Save the current settings' state to the given file. More...
virtual void	getSplitRecord (std::vector< makArchives::DtInterestManagementRecord > &rec, std::vector< std::string > &fileNames)
	For directory support, split the main record into different sub-records and give them each a file name. More...
virtual void	addRecords (makArchives::DtInterestManagementRecord &rec, makArchives::DtInterestManagementRecord &combinedRec)
	For directory support, when reading in a directory, add the records from each file to the combined record. More...
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor. More...
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor. More...

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

Protected Member Functions
	DtInterestManagementSettingsManager (DtDe &de)
	Protected CTOR ( use instance(..) ). More...

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

Additional Inherited Members
Protected Types inherited from makVrv::DtBaseSharedSettingsManager< makArchives::DtInterestManagementRecord, DtSharedInterestManagementSettings >
typedef DtSharedRecordSettingsBackup < DtSharedInterestManagementSettings, makArchives::DtInterestManagementRecord >	SharedRecordBackupType
Protected Attributes inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtInterestManagementRecord >
DtSignalConnectionManager	myConnections
std::string	myName
std::string	myExtension
std::string	myDisplayName
bool	myUseDefaultSettingsRecordFlag
bool	myAutoSaveFlag
DtSettingsBackup *	mySettingsBackup
DtDe &	myDe

Detailed Description

Manager for interest management (DDM) settings.

Constructor & Destructor Documentation

virtual makVrv::DtInterestManagementSettingsManager::~DtInterestManagementSettingsManager ( )

virtual

DTOR.

makVrv::DtInterestManagementSettingsManager::DtInterestManagementSettingsManager ( DtDe &  de )

protected

Protected CTOR ( use instance(..) ).

Member Function Documentation

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

static

Get an instance of the settings manager.

virtual void makVrv::DtInterestManagementSettingsManager::updateInterestManagementSettings ( )

virtual

Forces a reset of all current interest management settings to what they currently are to force signals to be sent.

virtual int makVrv::DtInterestManagementSettingsManager::ddmRegionSize ( ) const

virtual

Gets the DDM region size to use.

virtual void makVrv::DtInterestManagementSettingsManager::setDdmRegionSize ( int  size )

virtual

Sets the DDM region size to use.

virtual int makVrv::DtInterestManagementSettingsManager::regionUpdateThreshold ( ) const

virtual

Gets the threshold for region updates.

virtual void makVrv::DtInterestManagementSettingsManager::setRegionUpdateThreshold ( int  percentage )

virtual

Sets the threshold for region updates.

virtual bool makVrv::DtInterestManagementSettingsManager::altitudeThresholdEnabled ( ) const

virtual

Gets whether the altitude threshold for DDM regions is enabled.

virtual void makVrv::DtInterestManagementSettingsManager::setAltitudeThresholdEnabled ( bool  enabled )

virtual

Sets whether the altitude threshold for DDM regions is enabled.

virtual int makVrv::DtInterestManagementSettingsManager::altitudeThreshold ( ) const

virtual

Gets the altitude threshold for DDM regions.

virtual void makVrv::DtInterestManagementSettingsManager::setAltitudeThreshold ( int  threshold )

virtual

Sets the altitude threshold for DDM regions.

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

*  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 retreival/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));
*  

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtInterestManagementSettingsManager.h