MeasurementLayer Class Reference

Adjusts the properties of a MeasurementLayer. More...

#include <MeasurementLayer.h>

Inheritance diagram for MeasurementLayer:

Inheritance graph

List of all members.

Public Member Functions

virtual void setDisplayDistance (bool bDisplay)=0
virtual bool getDisplayDistance () const =0
virtual void setDisplayBearing (bool bDisplay)=0
virtual bool getDisplayBearing () const =0
virtual void setDisplayEndPoints (bool bDisplay)=0
virtual bool getDisplayEndPoints () const =0
virtual DistanceUnits getDistanceUnits () const =0
virtual void setDistanceUnits (DistanceUnits unit)=0
virtual void getGeocoordTypes (GeocoordType &geocoord, DmsFormatType &dms) const =0
virtual void setGeocoordTypes (GeocoordType geocoord, DmsFormatType dms)=0

Static Public Member Functions

static bool getSettingDisplayDistanceLabel ()
static bool hasSettingDisplayDistanceLabel ()
static void setSettingDisplayDistanceLabel (bool newValue, bool setIfSame=false)
static std::string getSettingDisplayDistanceLabelKey ()
static bool getSettingDisplayBearingLabel ()
static bool hasSettingDisplayBearingLabel ()
static void setSettingDisplayBearingLabel (bool newValue, bool setIfSame=false)
static std::string getSettingDisplayBearingLabelKey ()
static bool getSettingDisplayEndPointsLabel ()
static bool hasSettingDisplayEndPointsLabel ()
static void setSettingDisplayEndPointsLabel (bool newValue, bool setIfSame=false)
static std::string getSettingDisplayEndPointsLabelKey ()
static int getSettingDistancePrecision ()
static bool hasSettingDistancePrecision ()
static void setSettingDistancePrecision (int newValue, bool setIfSame=false)
static std::string getSettingDistancePrecisionKey ()
static int getSettingBearingPrecision ()
static bool hasSettingBearingPrecision ()
static void setSettingBearingPrecision (int newValue, bool setIfSame=false)
static std::string getSettingBearingPrecisionKey ()
static int getSettingEndPointsPrecision ()
static bool hasSettingEndPointsPrecision ()
static void setSettingEndPointsPrecision (int newValue, bool setIfSame=false)
static std::string getSettingEndPointsPrecisionKey ()
static ColorType getSettingLineColor ()
static bool hasSettingLineColor ()
static void setSettingLineColor (ColorType newValue, bool setIfSame=false)
static std::string getSettingLineColorKey ()
static LineStyle getSettingLineStyle ()
static bool hasSettingLineStyle ()
static void setSettingLineStyle (LineStyle newValue, bool setIfSame=false)
static std::string getSettingLineStyleKey ()
static unsigned int getSettingLineWidth ()
static bool hasSettingLineWidth ()
static void setSettingLineWidth (unsigned int newValue, bool setIfSame=false)
static std::string getSettingLineWidthKey ()
static ColorType getSettingTextColor ()
static bool hasSettingTextColor ()
static void setSettingTextColor (ColorType newValue, bool setIfSame=false)
static std::string getSettingTextColorKey ()
static std::string getSettingTextFont ()
static bool hasSettingTextFont ()
static void setSettingTextFont (std::string newValue, bool setIfSame=false)
static std::string getSettingTextFontKey ()
static unsigned int getSettingTextFontSize ()
static bool hasSettingTextFontSize ()
static void setSettingTextFontSize (unsigned int newValue, bool setIfSame=false)
static std::string getSettingTextFontSizeKey ()
static bool getSettingTextBold ()
static bool hasSettingTextBold ()
static void setSettingTextBold (bool newValue, bool setIfSame=false)
static std::string getSettingTextBoldKey ()
static bool getSettingTextItalics ()
static bool hasSettingTextItalics ()
static void setSettingTextItalics (bool newValue, bool setIfSame=false)
static std::string getSettingTextItalicsKey ()
static bool getSettingTextUnderline ()
static bool hasSettingTextUnderline ()
static void setSettingTextUnderline (bool newValue, bool setIfSame=false)
static std::string getSettingTextUnderlineKey ()
static DistanceUnits getSettingDistanceUnits ()
static bool hasSettingDistanceUnits ()
static void setSettingDistanceUnits (DistanceUnits newValue, bool setIfSame=false)
static std::string getSettingDistanceUnitsKey ()

Protected Member Functions

virtual ~MeasurementLayer ()


Detailed Description

Adjusts the properties of a MeasurementLayer.

This subclass of Subject will notify upon the following conditions:

See also:
AnnotationLayer

Definition at line 23 of file MeasurementLayer.h.


Constructor & Destructor Documentation

virtual MeasurementLayer::~MeasurementLayer (  )  [protected, virtual]

The MeasurementLayer is deleted by SpatialDataView when it is deleted.

Definition at line 785 of file MeasurementLayer.h.


Member Function Documentation

static bool MeasurementLayer::getSettingDisplayDistanceLabel (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 36 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingDisplayDistanceLabel (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 43 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingDisplayDistanceLabel ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 59 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingDisplayDistanceLabelKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 67 of file MeasurementLayer.h.

static bool MeasurementLayer::getSettingDisplayBearingLabel (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 78 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingDisplayBearingLabel (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 85 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingDisplayBearingLabel ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 101 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingDisplayBearingLabelKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 109 of file MeasurementLayer.h.

static bool MeasurementLayer::getSettingDisplayEndPointsLabel (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 120 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingDisplayEndPointsLabel (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 127 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingDisplayEndPointsLabel ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 143 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingDisplayEndPointsLabelKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 151 of file MeasurementLayer.h.

static int MeasurementLayer::getSettingDistancePrecision (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 162 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingDistancePrecision (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 169 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingDistancePrecision ( int  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 185 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingDistancePrecisionKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 193 of file MeasurementLayer.h.

static int MeasurementLayer::getSettingBearingPrecision (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 204 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingBearingPrecision (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 211 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingBearingPrecision ( int  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 227 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingBearingPrecisionKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 235 of file MeasurementLayer.h.

static int MeasurementLayer::getSettingEndPointsPrecision (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 246 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingEndPointsPrecision (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 253 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingEndPointsPrecision ( int  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 269 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingEndPointsPrecisionKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 277 of file MeasurementLayer.h.

static ColorType MeasurementLayer::getSettingLineColor (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented from GraphicLayer.

Definition at line 288 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingLineColor (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented from GraphicLayer.

Definition at line 295 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingLineColor ( ColorType  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented from GraphicLayer.

Definition at line 311 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingLineColorKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented from GraphicLayer.

Definition at line 319 of file MeasurementLayer.h.

static LineStyle MeasurementLayer::getSettingLineStyle (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented from GraphicLayer.

Definition at line 330 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingLineStyle (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented from GraphicLayer.

Definition at line 337 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingLineStyle ( LineStyle  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented from GraphicLayer.

Definition at line 353 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingLineStyleKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented from GraphicLayer.

Definition at line 361 of file MeasurementLayer.h.

static unsigned int MeasurementLayer::getSettingLineWidth (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented from GraphicLayer.

Definition at line 372 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingLineWidth (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented from GraphicLayer.

Definition at line 379 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingLineWidth ( unsigned int  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented from GraphicLayer.

Definition at line 395 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingLineWidthKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented from GraphicLayer.

Definition at line 403 of file MeasurementLayer.h.

static ColorType MeasurementLayer::getSettingTextColor (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented from GraphicLayer.

Definition at line 414 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingTextColor (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented from GraphicLayer.

Definition at line 421 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingTextColor ( ColorType  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented from GraphicLayer.

Definition at line 437 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingTextColorKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented from GraphicLayer.

Definition at line 445 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingTextFont (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented from GraphicLayer.

Definition at line 456 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingTextFont (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented from GraphicLayer.

Definition at line 463 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingTextFont ( std::string  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented from GraphicLayer.

Definition at line 479 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingTextFontKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

@return the key used for this setting.

Reimplemented from GraphicLayer.

Definition at line 487 of file MeasurementLayer.h.

static unsigned int MeasurementLayer::getSettingTextFontSize (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented from GraphicLayer.

Definition at line 498 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingTextFontSize (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented from GraphicLayer.

Definition at line 505 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingTextFontSize ( unsigned int  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented from GraphicLayer.

Definition at line 521 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingTextFontSizeKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented from GraphicLayer.

Definition at line 529 of file MeasurementLayer.h.

static bool MeasurementLayer::getSettingTextBold (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented from GraphicLayer.

Definition at line 540 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingTextBold (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented from GraphicLayer.

Definition at line 547 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingTextBold ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented from GraphicLayer.

Definition at line 563 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingTextBoldKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented from GraphicLayer.

Definition at line 571 of file MeasurementLayer.h.

static bool MeasurementLayer::getSettingTextItalics (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented from GraphicLayer.

Definition at line 582 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingTextItalics (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented from GraphicLayer.

Definition at line 589 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingTextItalics ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented from GraphicLayer.

Definition at line 605 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingTextItalicsKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented from GraphicLayer.

Definition at line 613 of file MeasurementLayer.h.

static bool MeasurementLayer::getSettingTextUnderline (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Reimplemented from GraphicLayer.

Definition at line 624 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingTextUnderline (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Reimplemented from GraphicLayer.

Definition at line 631 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingTextUnderline ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Reimplemented from GraphicLayer.

Definition at line 647 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingTextUnderlineKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Reimplemented from GraphicLayer.

Definition at line 655 of file MeasurementLayer.h.

static DistanceUnits MeasurementLayer::getSettingDistanceUnits (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 666 of file MeasurementLayer.h.

static bool MeasurementLayer::hasSettingDistanceUnits (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 673 of file MeasurementLayer.h.

static void MeasurementLayer::setSettingDistanceUnits ( DistanceUnits  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 689 of file MeasurementLayer.h.

static std::string MeasurementLayer::getSettingDistanceUnitsKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 697 of file MeasurementLayer.h.

virtual void MeasurementLayer::setDisplayDistance ( bool  bDisplay  )  [pure virtual]

Sets the status of displaying the distance text.

Parameters:
bDisplay The new display status for the distance text.

virtual bool MeasurementLayer::getDisplayDistance (  )  const [pure virtual]

Returns the display status of the distance text.

Returns:
The distance display status.

virtual void MeasurementLayer::setDisplayBearing ( bool  bDisplay  )  [pure virtual]

Sets the status of displaying the bearing text.

Parameters:
bDisplay The new display status for the bearing text.

virtual bool MeasurementLayer::getDisplayBearing (  )  const [pure virtual]

Returns the display status of the bearing text.

Returns:
The bearing display status.

virtual void MeasurementLayer::setDisplayEndPoints ( bool  bDisplay  )  [pure virtual]

Sets the status of displaying the end points text.

Parameters:
bDisplay The new display status for the end points text.

virtual bool MeasurementLayer::getDisplayEndPoints (  )  const [pure virtual]

Returns the display status of the end points text.

Returns:
The end points display status.

virtual DistanceUnits MeasurementLayer::getDistanceUnits (  )  const [pure virtual]

Returns the units used in displaying the distance.

Returns:
The distance units.

virtual void MeasurementLayer::setDistanceUnits ( DistanceUnits  unit  )  [pure virtual]

Sets the units to use in displaying the distance.

Parameters:
unit The units to use in displaying the distance.

virtual void MeasurementLayer::getGeocoordTypes ( GeocoordType geocoord,
DmsFormatType dms 
) const [pure virtual]

Returns the geocoordinate type and data format used in displaying the end point locations.

Parameters:
geocoord The geocoordinate type.
dms The data format

virtual void MeasurementLayer::setGeocoordTypes ( GeocoordType  geocoord,
DmsFormatType  dms 
) [pure virtual]

Sets the geocoordinate type and data format to use in displaying the end points locations.

Parameters:
geocoord The geocoordinate type.
dms The data format.


Software Development Kit - Opticks 4.9.0 Build 16218