makVrv::DtRadioCommunicationsSettingsManager Class Reference

Manager for the radio communications settings. More...

Inheritance diagram for makVrv::DtRadioCommunicationsSettingsManager:

List of all members.

Public Member Functions
virtual	~DtRadioCommunicationsSettingsManager ()
	DTOR.
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 ()
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 Member Functions
	DtRadioCommunicationsSettingsManager (DtDe &de)
	Protected CTOR ( use instance(..) ).
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.

---

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.

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]

---

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.

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.

 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:

• include/vrvCore/DtRadioCommunicationsSettingsManager.h