Manager for the radio communications settings. More...

Inheritance diagram for makVrv::DtRadioCommunicationsSettingsManager:

Public Member Functions
virtual	~DtRadioCommunicationsSettingsManager ()
	DTOR.
void	connectInputSignals ()
	Connect to signal indicating settings have been backed up.
General
virtual float	commLineLifetime () const
virtual void	setCommLineLifetime (float lifetime)
virtual float	squawkIndicatorLifetime () const
virtual void	setSquawkIndicatorLifetime (float lifetime)
virtual float	commLineAnimationRate () const
virtual void	setCommLineAnimationRate (float rate)
virtual float	squawkIndicatorAnimationRate () const
virtual void	setSquawkIndicatorAnimationRate (float rate)
virtual bool	displayCommLines () const
virtual void	setDisplayCommLines (bool show)
virtual bool	displaySquawkIndicators () const
virtual void	setDisplaySquawkIndicators (bool show)
virtual bool	displayRadioCommunications () const
virtual void	setDisplayRadioCommunications (bool show)
virtual CommLineMode	commLineRenderMode () const
virtual void	setCommLineRenderMode (CommLineMode mode)
virtual double	greatCircleExaggerationAmount () const
virtual void	setGreatCircleExaggerationAmount (double amount)
virtual DefaultColoringMode	defaultColoringMode () const
virtual void	setDefaultColoringMode (DefaultColoringMode mode)
Default Frequency Range
virtual bool	showDefaultFrequency () const
virtual void	setShowDefaultFrequency (bool show)
virtual void	getDefaultFrequencyColor (float &r, float &g, float &b) const
virtual void	setDefaultFrequencyColor (float r, float g, float b)
Custom Frequency Ranges
virtual void	getFrequencyRangeColor (int rangeIndex, float &r, float &g, float &b) const
virtual void	setFrequencyRangeColor (int rangeIndex, float r, float g, float b)
virtual bool	showFrequencyRangeFrequency (int rangeIndex) const
virtual void	setShowFrequencyRangeFrequency (int rangeIndex, bool show)
virtual void	getFrequencyRange (int rangeIndex, float &lowFreq, float &highFreq) const
virtual int	addFrequencyRange (float lowFreq, float highFreq)
virtual int	numFrequencyRanges () const
virtual void	clearFrequencyRanges ()
Public Member Functions inherited from makVrv::DtBaseSharedSettingsManager< makArchives::DtRadioCommunicationsSettingsRecord, DtSharedRadioCommunicationsSettings >
	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	setFromRecord (const makArchives::DtRadioCommunicationsSettingsRecord &record)
	Set the current settings' state from the given record.
virtual void	getRecord (makArchives::DtRadioCommunicationsSettingsRecord &record) const
	Store the current settings' state in the given record.
Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtRadioCommunicationsSettingsRecord >
	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::DtRadioCommunicationsSettingsRecord > &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::DtRadioCommunicationsSettingsRecord &rec, makArchives::DtRadioCommunicationsSettingsRecord &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 DtRadioCommunicationsSettingsManager &	instance (DtDe &de)
	Get an instance of the settings manager.
static void	registerInstance (DtDe &de, DtRadioCommunicationsSettingsManager *instance)
	Register a new instance.

Protected Types
typedef makArchives::DtRadioCommunicationsSettingsRecord::CommLineMode	CommLineMode
	Enum typedef to allow usage of the record's mode enum locally.
typedef makArchives::DtRadioCommunicationsSettingsRecord::DefaultColoringMode	DefaultColoringMode
	Enum typedef to allow usage of the record's coloring enum locally.
Protected Types inherited from makVrv::DtBaseSharedSettingsManager< makArchives::DtRadioCommunicationsSettingsRecord, DtSharedRadioCommunicationsSettings >
typedef DtSharedRecordSettingsBackup < DtSharedRadioCommunicationsSettings, makArchives::DtRadioCommunicationsSettingsRecord >	SharedRecordBackupType

Protected Member Functions
	DtRadioCommunicationsSettingsManager (DtDe &de)
	Protected CTOR ( use instance(..) ).
virtual void	slot_backupRestored (const DtSettingsBackup *s)
	Called when the setting is restored, save out if auto save is true.

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 Attributes inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtRadioCommunicationsSettingsRecord >
DtSignalConnectionManager	myConnections
std::string	myName
std::string	myExtension
std::string	myDisplayName
bool	myUseDefaultSettingsRecordFlag
bool	myAutoSaveFlag
DtSettingsBackup *	mySettingsBackup
DtDe &	myDe

Detailed Description

Manager for the radio communications settings.

Member Typedef Documentation

typedef makArchives::DtRadioCommunicationsSettingsRecord::CommLineMode makVrv::DtRadioCommunicationsSettingsManager::CommLineMode

protected

Enum typedef to allow usage of the record's mode enum locally.

typedef makArchives::DtRadioCommunicationsSettingsRecord::DefaultColoringMode makVrv::DtRadioCommunicationsSettingsManager::DefaultColoringMode

protected

Enum typedef to allow usage of the record's coloring enum locally.

Constructor & Destructor Documentation

virtual makVrv::DtRadioCommunicationsSettingsManager::~DtRadioCommunicationsSettingsManager ( )

virtual

DTOR.

makVrv::DtRadioCommunicationsSettingsManager::DtRadioCommunicationsSettingsManager ( DtDe & de )

protected

Protected CTOR ( use instance(..) ).

Member Function Documentation

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

static

Get an instance of the settings manager.

static void makVrv::DtRadioCommunicationsSettingsManager::registerInstance	(	DtDe &	de,
		DtRadioCommunicationsSettingsManager *	instance
	)

static

Register a new instance.

void makVrv::DtRadioCommunicationsSettingsManager::connectInputSignals ( )

Connect to signal indicating settings have been backed up.

virtual float makVrv::DtRadioCommunicationsSettingsManager::commLineLifetime ( ) const

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::setCommLineLifetime ( float lifetime )

virtual

virtual float makVrv::DtRadioCommunicationsSettingsManager::squawkIndicatorLifetime ( ) const

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::setSquawkIndicatorLifetime ( float lifetime )

virtual

virtual float makVrv::DtRadioCommunicationsSettingsManager::commLineAnimationRate ( ) const

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::setCommLineAnimationRate ( float rate )

virtual

virtual float makVrv::DtRadioCommunicationsSettingsManager::squawkIndicatorAnimationRate ( ) const

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::setSquawkIndicatorAnimationRate ( float rate )

virtual

virtual bool makVrv::DtRadioCommunicationsSettingsManager::displayCommLines ( ) const

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::setDisplayCommLines ( bool show )

virtual

virtual bool makVrv::DtRadioCommunicationsSettingsManager::displaySquawkIndicators ( ) const

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::setDisplaySquawkIndicators ( bool show )

virtual

virtual bool makVrv::DtRadioCommunicationsSettingsManager::displayRadioCommunications ( ) const

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::setDisplayRadioCommunications ( bool show )

virtual

virtual CommLineMode makVrv::DtRadioCommunicationsSettingsManager::commLineRenderMode ( ) const

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::setCommLineRenderMode ( CommLineMode mode )

virtual

virtual double makVrv::DtRadioCommunicationsSettingsManager::greatCircleExaggerationAmount ( ) const

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::setGreatCircleExaggerationAmount ( double amount )

virtual

virtual DefaultColoringMode makVrv::DtRadioCommunicationsSettingsManager::defaultColoringMode ( ) const

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::setDefaultColoringMode ( DefaultColoringMode mode )

virtual

virtual bool makVrv::DtRadioCommunicationsSettingsManager::showDefaultFrequency ( ) const

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::setShowDefaultFrequency ( bool show )

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::getDefaultFrequencyColor	(	float &	r,
		float &	g,
		float &	b
	)		const

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::setDefaultFrequencyColor	(	float	r,
		float	g,
		float	b
	)

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::getFrequencyRangeColor	(	int	rangeIndex,
		float &	r,
		float &	g,
		float &	b
	)		const

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::setFrequencyRangeColor	(	int	rangeIndex,
		float	r,
		float	g,
		float	b
	)

virtual

virtual bool makVrv::DtRadioCommunicationsSettingsManager::showFrequencyRangeFrequency ( int rangeIndex ) const

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::setShowFrequencyRangeFrequency	(	int	rangeIndex,
		bool	show
	)

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::getFrequencyRange	(	int	rangeIndex,
		float &	lowFreq,
		float &	highFreq
	)		const

virtual

virtual int makVrv::DtRadioCommunicationsSettingsManager::addFrequencyRange	(	float	lowFreq,
		float	highFreq
	)

virtual

virtual int makVrv::DtRadioCommunicationsSettingsManager::numFrequencyRanges ( ) const

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::clearFrequencyRanges ( )

virtual

virtual void makVrv::DtRadioCommunicationsSettingsManager::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));

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

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

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation