makVrv::DtSharedRadioCommunicationsSettings Class Reference

This class will maintain settings regarding radio communications. More...

Inheritance diagram for makVrv::DtSharedRadioCommunicationsSettings:

Classes
struct	FrequencyRangeAttributes
	Stores parameters for a single frequency range. More...

Public Member Functions
virtual	~DtSharedRadioCommunicationsSettings ()
	DTOR.
General
virtual float	commLineLifetime () const
	Getter/Setter for the default lifetime for comm lines.
virtual void	setCommLineLifetime (float lifetime)
	Getter/Setter for the default lifetime for comm lines.
virtual float	squawkIndicatorLifetime () const
	Getter/Setter for the default lifetime for squawk indicators.
virtual void	setSquawkIndicatorLifetime (float lifetime)
	Getter/Setter for the default lifetime for squawk indicators.
virtual float	commLineAnimationRate () const
	Getter/Setter for the default animation rate for comm lines.
virtual void	setCommLineAnimationRate (float rate)
	Getter/Setter for the default animation rate for comm lines.
virtual float	squawkIndicatorAnimationRate () const
	Getter/Setter for the default animation rate for squawk indicators.
virtual void	setSquawkIndicatorAnimationRate (float rate)
	Getter/Setter for the default animation rate for squawk indicators.
virtual bool	displayCommLines () const
	Getter/Setter for enabling the display of comm lines.
virtual void	setDisplayCommLines (bool show)
	Getter/Setter for enabling the display of comm lines.
virtual bool	displaySquawkIndicators () const
	Getter/Setter for enabling the display of squawk indicators.
virtual void	setDisplaySquawkIndicators (bool show)
	Getter/Setter for enabling the display of squawk indicators.
virtual bool	displayRadioCommunications () const
	Getter/Setter for enabling radio communications processing.
virtual void	setDisplayRadioCommunications (bool show)
	Getter/Setter for enabling radio communications processing.
virtual CommLineMode	commLineRenderMode () const
	Getter/Setter for the mode used to draw comm lines.
virtual void	setCommLineRenderMode (CommLineMode mode)
	Getter/Setter for the mode used to draw comm lines.
virtual double	greatCircleExaggerationAmount () const
	Getter/Setter for the great circle arc exaggeration amount.
virtual void	setGreatCircleExaggerationAmount (double amount)
	Getter/Setter for the great circle arc exaggeration amount.
virtual DefaultColoringMode	defaultColoringMode () const
	Getter/Setter for the mode used to color lines / indicators.
virtual void	setDefaultColoringMode (DefaultColoringMode mode)
	Getter/Setter for the mode used to color lines / indicators.
Default Frequency Range (All)
virtual bool	showDefaultFrequency () const
	Getter/Setter for whether to show communications in the default frequencies.
virtual void	setShowDefaultFrequency (bool show)
	Getter/Setter for whether to show communications in the default frequencies.
virtual void	getDefaultFrequencyColor (float &r, float &g, float &b) const
	Getter/Setter for the default color to use for communications.
virtual void	setDefaultFrequencyColor (float r, float g, float b)
	Getter/Setter for whether to show communications in the default frequencies.
Custom Frequency Ranges
virtual void	getFrequencyRange (int rangeIndex, float &lowFreq, float &highFreq) const
	Getter/Setter for custom frequency ranges.
virtual int	addFrequencyRange (float lowFreq, float highFreq)
	Getter/Setter for custom frequency ranges.
virtual void	getFrequencyRangeColor (int rangeIndex, float &r, float &g, float &b) const
	Getter/Setter for the color for a given frequency range.
virtual void	setFrequencyRangeColor (int rangeIndex, float r, float g, float b)
	Getter/Setter for custom frequency ranges.
virtual bool	showFrequencyRangeFrequency (int rangeIndex) const
	Getter/Setter for modifying the visibility of a given frequency range.
virtual void	setShowFrequencyRangeFrequency (int rangeIndex, bool show)
	Getter/Setter for custom frequency ranges.
virtual int	numFrequencyRanges () const
	Accessor for the number of custon frequency ranges.
virtual void	clearFrequencyRanges ()
	Removes all custom frequency ranges.
Settings record / backup methods
void	setFromRecord (const makArchives::DtRadioCommunicationsSettingsRecord &rec)
	Restore the settings from a record.
void	getRecord (makArchives::DtRadioCommunicationsSettingsRecord &rec) const
	Get the settings as a record.
virtual const DtRadioCommunicationsSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
virtual DtRadioCommunicationsSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the settings.
Public Member Functions inherited from makVrv::DtSharedSettings
	DtSharedSettings (const DtSharedSettingsManager &manager)
	CTOR.
virtual	~DtSharedSettings ()
	DTOR.
boost::shared_mutex &	mutex ()
	Get the mutex for the settings object.
SafetyKey	safeToEmitSignals ()
	Create a safety key for the function, see above example.
void	setCurrentWriteLock (boost::unique_lock< boost::shared_mutex > *currentWriteLock)
	No need to call, set by the DtWriteSettingLock object.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static std::string	className ()
	The class name for this settings object.

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.
typedef std::vector < FrequencyRangeAttributes >	FrequencyRangeAttributesList
	Vector type for storing frequency range attributes.

Protected Member Functions
	DtSharedRadioCommunicationsSettings (DtSharedSettingsManager &manager)
	Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

Protected Attributes
FrequencyRangeAttributesList	myFrequencyRangeAttributes
float	myDefaultFrequencyRangeColor [3]
bool	myShowDefaultFrequencyFlag
float	myCommLineLifetime
float	mySquawkIndicatorLifetime
float	myCommLineAnimationRate
float	mySquawkIndicatorAnimationRate
bool	myDisplayCommLinesFlag
bool	myDisplaySquawkIndicatorsFlag
bool	myDisplayRadioCommunicationsFlag
CommLineMode	myCommunicationLineRenderMode
float	myGreatCircleExaggerationAmount
DefaultColoringMode	myDefaultColoringMode
DtRadioCommunicationsSettingsBackup *	mySettingsBackup

Friends
class	DtReadSettingsLock< DtSharedRadioCommunicationsSettings >
	Use the DtReadSettingsLock to read the object.
class	DtWriteSettingsLock< DtSharedRadioCommunicationsSettings >
	Use the DtWriteSettingsLock to write to the object.

Detailed Description

This class will maintain settings regarding radio communications.

Member Typedef Documentation

typedef makArchives::DtRadioCommunicationsSettingsRecord::CommLineMode makVrv::DtSharedRadioCommunicationsSettings::CommLineMode

protected

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

typedef makArchives::DtRadioCommunicationsSettingsRecord::DefaultColoringMode makVrv::DtSharedRadioCommunicationsSettings::DefaultColoringMode

protected

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

typedef std::vector<FrequencyRangeAttributes> makVrv::DtSharedRadioCommunicationsSettings::FrequencyRangeAttributesList

protected

Vector type for storing frequency range attributes.

Constructor & Destructor Documentation

virtual makVrv::DtSharedRadioCommunicationsSettings::~DtSharedRadioCommunicationsSettings ( )

virtual

DTOR.

makVrv::DtSharedRadioCommunicationsSettings::DtSharedRadioCommunicationsSettings ( DtSharedSettingsManager &  manager )

protected

Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

Member Function Documentation

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

virtual

Getter/Setter for the default lifetime for comm lines.

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

virtual

Getter/Setter for the default lifetime for comm lines.

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

virtual

Getter/Setter for the default lifetime for squawk indicators.

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

virtual

Getter/Setter for the default lifetime for squawk indicators.

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

virtual

Getter/Setter for the default animation rate for comm lines.

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

virtual

Getter/Setter for the default animation rate for comm lines.

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

virtual

Getter/Setter for the default animation rate for squawk indicators.

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

virtual

Getter/Setter for the default animation rate for squawk indicators.

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

virtual

Getter/Setter for enabling the display of comm lines.

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

virtual

Getter/Setter for enabling the display of comm lines.

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

virtual

Getter/Setter for enabling the display of squawk indicators.

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

virtual

Getter/Setter for enabling the display of squawk indicators.

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

virtual

Getter/Setter for enabling radio communications processing.

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

virtual

Getter/Setter for enabling radio communications processing.

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

virtual

Getter/Setter for the mode used to draw comm lines.

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

virtual

Getter/Setter for the mode used to draw comm lines.

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

virtual

Getter/Setter for the great circle arc exaggeration amount.

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

virtual

Getter/Setter for the great circle arc exaggeration amount.

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

virtual

Getter/Setter for the mode used to color lines / indicators.

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

virtual

Getter/Setter for the mode used to color lines / indicators.

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

virtual

Getter/Setter for whether to show communications in the default frequencies.

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

virtual

Getter/Setter for whether to show communications in the default frequencies.

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

virtual

Getter/Setter for the default color to use for communications.

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

virtual

Getter/Setter for whether to show communications in the default frequencies.

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

virtual

Getter/Setter for custom frequency ranges.

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

virtual

Getter/Setter for custom frequency ranges.

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

virtual

Getter/Setter for the color for a given frequency range.

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

virtual

Getter/Setter for custom frequency ranges.

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

virtual

Getter/Setter for modifying the visibility of a given frequency range.

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

virtual

Getter/Setter for custom frequency ranges.

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

virtual

Accessor for the number of custon frequency ranges.

virtual void makVrv::DtSharedRadioCommunicationsSettings::clearFrequencyRanges ( )

virtual

Removes all custom frequency ranges.

void makVrv::DtSharedRadioCommunicationsSettings::setFromRecord

(

const makArchives::DtRadioCommunicationsSettingsRecord &

rec

)

Restore the settings from a record.

void makVrv::DtSharedRadioCommunicationsSettings::getRecord

(

makArchives::DtRadioCommunicationsSettingsRecord &

rec

)

const

Get the settings as a record.

virtual const DtRadioCommunicationsSettingsBackup* makVrv::DtSharedRadioCommunicationsSettings::settingsBackup ( ) const

virtual

Accessor for the settings backup (const).

Reimplemented from makVrv::DtSharedSettings.

virtual DtRadioCommunicationsSettingsBackup* makVrv::DtSharedRadioCommunicationsSettings::settingsBackup ( )

virtual

Accessor for the settings backup.

Reimplemented from makVrv::DtSharedSettings.

virtual void makVrv::DtSharedRadioCommunicationsSettings::backup ( )

virtual

Called to back up the settings.

Reimplemented from makVrv::DtSharedSettings.

static std::string makVrv::DtSharedRadioCommunicationsSettings::className ( )

static

The class name for this settings object.

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSharedRadioCommunicationsSettings >

friend

Use the DtReadSettingsLock to read the object.

friend class DtWriteSettingsLock< DtSharedRadioCommunicationsSettings >

friend

Use the DtWriteSettingsLock to write to the object.

Member Data Documentation

FrequencyRangeAttributesList makVrv::DtSharedRadioCommunicationsSettings::myFrequencyRangeAttributes

protected

float makVrv::DtSharedRadioCommunicationsSettings::myDefaultFrequencyRangeColor[3]

protected

bool makVrv::DtSharedRadioCommunicationsSettings::myShowDefaultFrequencyFlag

protected

float makVrv::DtSharedRadioCommunicationsSettings::myCommLineLifetime

protected

float makVrv::DtSharedRadioCommunicationsSettings::mySquawkIndicatorLifetime

protected

float makVrv::DtSharedRadioCommunicationsSettings::myCommLineAnimationRate

protected

float makVrv::DtSharedRadioCommunicationsSettings::mySquawkIndicatorAnimationRate

protected

bool makVrv::DtSharedRadioCommunicationsSettings::myDisplayCommLinesFlag

protected

bool makVrv::DtSharedRadioCommunicationsSettings::myDisplaySquawkIndicatorsFlag

protected

bool makVrv::DtSharedRadioCommunicationsSettings::myDisplayRadioCommunicationsFlag

protected

CommLineMode makVrv::DtSharedRadioCommunicationsSettings::myCommunicationLineRenderMode

protected

float makVrv::DtSharedRadioCommunicationsSettings::myGreatCircleExaggerationAmount

protected

DefaultColoringMode makVrv::DtSharedRadioCommunicationsSettings::myDefaultColoringMode

protected

DtRadioCommunicationsSettingsBackup* makVrv::DtSharedRadioCommunicationsSettings::mySettingsBackup

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrvCore/DtSharedRadioCommunicationsSettings.h