LatLonLayer Class Reference

Adjusts the properties of a latitude/longitude layer. More...

#include <LatLonLayer.h>

Inheritance diagram for LatLonLayer:

List of all members.

Public Member Functions

virtual void setColor (const ColorType &colorType)=0

virtual ColorType getColor () const =0

virtual void setStyle (const LatLonStyle &eStyle)=0

virtual LatLonStyle getStyle () const =0

virtual void setWidth (unsigned int width)=0

virtual unsigned int getWidth () const =0

virtual void setTickSpacing (const LocationType &spacing)=0

virtual LocationType getTickSpacing () const =0

virtual void setAutoTickSpacing (bool bAutoSpacing)=0

virtual bool getAutoTickSpacing () const =0

virtual void setFont (const Font &font)=0

virtual const Font & getFont () const =0

virtual void setGeocoordType (const GeocoordType &system)=0

virtual GeocoordType getGeocoordType () const =0

virtual void setLatLonFormat (const DmsFormatType &eFormat)=0

virtual DmsFormatType getLatLonFormat () const =0

Static Public Member Functions

static std::string getSettingFont ()

static bool hasSettingFont ()

static void setSettingFont (std::string newValue, bool setIfSame=false)

static std::string getSettingFontKey ()

static unsigned int getSettingFontSize ()

static bool hasSettingFontSize ()

static void setSettingFontSize (unsigned int newValue, bool setIfSame=false)

static std::string getSettingFontSizeKey ()

static ColorType getSettingGridlineColor ()

static bool hasSettingGridlineColor ()

static void setSettingGridlineColor (ColorType newValue, bool setIfSame=false)

static std::string getSettingGridlineColorKey ()

static LatLonStyle getSettingGridlineStyle ()

static bool hasSettingGridlineStyle ()

static void setSettingGridlineStyle (LatLonStyle newValue, bool setIfSame=false)

static std::string getSettingGridlineStyleKey ()

static unsigned int getSettingGridlineWidth ()

static bool hasSettingGridlineWidth ()

static void setSettingGridlineWidth (unsigned int newValue, bool setIfSame=false)

static std::string getSettingGridlineWidthKey ()

static const std::string & signalFormatChanged ()

static const std::string & signalColorChanged ()

static const std::string & signalFontChanged ()

static const std::string & signalStyleChanged ()

static const std::string & signalWidthChanged ()

static const std::string & signalTickSpacingChanged ()

static const std::string & signalAutoTickSpacingChanged ()

static const std::string & signalCoordTypeChanged ()

Protected Member Functions

virtual ~LatLonLayer ()

Detailed Description

Adjusts the properties of a latitude/longitude layer.

A latitude/longitude layer consists of gridlines marking the location of equal latitude and equal longitude values. The gridlines have four properties: color, style, width and tick spacing. This class also contains a flag where the tick spacing will be automatically calculated for the current layer. This class provides the means to set the properties for the current lat/long layer and also the default properties for new lat/long layers.

This subclass of Subject will notify upon the following conditions:

The following methods are called: setLatLonFormat(), setColor(), setFont(), setStyle(), setWidth(), setTickSpacing(), setAutoTickSpacing(), setGeocoordType(),
Everything else documented in Layer.

See also:: Layer

Definition at line 41 of file LatLonLayer.h.

Constructor & Destructor Documentation

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

This should be destroyed by calling SpatialDataView::deleteLayer.

Definition at line 478 of file LatLonLayer.h.

Member Function Documentation

static std::string LatLonLayer::getSettingFont ( ) [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 54 of file LatLonLayer.h.

static bool LatLonLayer::hasSettingFont ( ) [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 61 of file LatLonLayer.h.

static void LatLonLayer::setSettingFont	(	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.

Definition at line 77 of file LatLonLayer.h.

static std::string LatLonLayer::getSettingFontKey ( ) [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.

Definition at line 85 of file LatLonLayer.h.

static unsigned int LatLonLayer::getSettingFontSize ( ) [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 96 of file LatLonLayer.h.

static bool LatLonLayer::hasSettingFontSize ( ) [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 103 of file LatLonLayer.h.

static void LatLonLayer::setSettingFontSize	(	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.

Definition at line 119 of file LatLonLayer.h.

static std::string LatLonLayer::getSettingFontSizeKey ( ) [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 127 of file LatLonLayer.h.

static ColorType LatLonLayer::getSettingGridlineColor ( ) [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 138 of file LatLonLayer.h.

static bool LatLonLayer::hasSettingGridlineColor ( ) [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 145 of file LatLonLayer.h.

static void LatLonLayer::setSettingGridlineColor	(	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.

Definition at line 161 of file LatLonLayer.h.

static std::string LatLonLayer::getSettingGridlineColorKey ( ) [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 169 of file LatLonLayer.h.

static LatLonStyle LatLonLayer::getSettingGridlineStyle ( ) [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 180 of file LatLonLayer.h.

static bool LatLonLayer::hasSettingGridlineStyle ( ) [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 187 of file LatLonLayer.h.

static void LatLonLayer::setSettingGridlineStyle	(	LatLonStyle	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 203 of file LatLonLayer.h.

static std::string LatLonLayer::getSettingGridlineStyleKey ( ) [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 211 of file LatLonLayer.h.

static unsigned int LatLonLayer::getSettingGridlineWidth ( ) [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 222 of file LatLonLayer.h.

static bool LatLonLayer::hasSettingGridlineWidth ( ) [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 229 of file LatLonLayer.h.

static void LatLonLayer::setSettingGridlineWidth	(	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.

Definition at line 245 of file LatLonLayer.h.

static std::string LatLonLayer::getSettingGridlineWidthKey ( ) [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 253 of file LatLonLayer.h.

static const std::string& LatLonLayer::signalFormatChanged ( ) [static]

Emitted with any<DmsFormatType> when the numeric format changes.

Definition at line 258 of file LatLonLayer.h.

static const std::string& LatLonLayer::signalColorChanged ( ) [static]

Emitted with any<ColorType> when the grid color changes.

Definition at line 262 of file LatLonLayer.h.

static const std::string& LatLonLayer::signalFontChanged ( ) [static]

Emitted with any<QFont> when the grid font changes.

Definition at line 266 of file LatLonLayer.h.

static const std::string& LatLonLayer::signalStyleChanged ( ) [static]

Emitted with any<LatLonStyle> when the grid style changes.

Definition at line 270 of file LatLonLayer.h.

static const std::string& LatLonLayer::signalWidthChanged ( ) [static]

Emitted with any<unsigned int> when the grid line width changes.

Definition at line 274 of file LatLonLayer.h.

static const std::string& LatLonLayer::signalTickSpacingChanged ( ) [static]

Emitted with any<LocationType> when the tick spacing changes.

Definition at line 278 of file LatLonLayer.h.

static const std::string& LatLonLayer::signalAutoTickSpacingChanged ( ) [static]

Emitted with any<bool> when autocomputing of tick spacing changes.

Definition at line 282 of file LatLonLayer.h.

static const std::string& LatLonLayer::signalCoordTypeChanged ( ) [static]

Emitted with any<GeocoordType> when the coordinate system changes.

Definition at line 286 of file LatLonLayer.h.

virtual void LatLonLayer::setColor ( const ColorType & colorType ) [pure virtual]

Sets the line color for the current lat/long layer.

Parameters:

colorType

The new line color, which must be valid

Subject Notifications:: This method will notify Subject::signalModified.

See also:: getColor(), ColorType::isValid()

virtual ColorType LatLonLayer::getColor ( ) const [pure virtual]

Returns the line color of the current lat/long layer.

Returns:: The current line color.

See also:: setColor()

virtual void LatLonLayer::setStyle ( const LatLonStyle & eStyle ) [pure virtual]

Sets the line style for the current lat/long layer.

Parameters:

eStyle

The new line style.

Subject Notifications:: This method will notify Subject::signalModified.

See also:: getStyle()

virtual LatLonStyle LatLonLayer::getStyle ( ) const [pure virtual]

Returns the line style of the current lat/long layer.

Returns:: The current line style.

See also:: setStyle()

virtual void LatLonLayer::setWidth ( unsigned int width ) [pure virtual]

Sets the line width for the current lat/long layer.

Parameters:

width

The new line width.

Subject Notifications:: This method will notify Subject::signalModified.

See also:: getWidth()

virtual unsigned int LatLonLayer::getWidth ( ) const [pure virtual]

Returns the line width of the current lat/long layer.

Returns:: The current line width.

See also:: setWidth()

virtual void LatLonLayer::setTickSpacing ( const LocationType & spacing ) [pure virtual]

Sets the gridline tick spacing of the current lat/long layer.

The tick spacing defines the distance separating the gridlines. This method sets both the latitude and longitude (X and Y) spacing. Calling this method disables auto tick spacing.

Parameters:

spacing

The tick spacing in the X and Y dimensions as a LocationType. The spacing should be in the geocoordinate system specified in setGeocoordType().

Subject Notifications:: This method will notify Subject::signalModified.

See also:: getTickSpacing()

virtual LocationType LatLonLayer::getTickSpacing ( ) const [pure virtual]

Returns the gridline tick spacing of the current lat/long layer.

Returns:: The tick spacing in the X and Y dimensions as a LocationType.

See also:: setTickSpacing()

virtual void LatLonLayer::setAutoTickSpacing ( bool bAutoSpacing ) [pure virtual]

Turns on or off auto computed tick spacing.

This method sets the current lat/long layer to automatically calculate the tick spacing.

Parameters:

bAutoSpacing

TRUE to automatically calculate the tick spacing. FALSE to use the manually set values.

Subject Notifications:: This method will notify Subject::signalModified.

See also:: getAutoTickSpacing()

virtual bool LatLonLayer::getAutoTickSpacing ( ) const [pure virtual]

Returns the current state of auto computed tick spacing.

Returns:: TRUE if the layer is set to automatically calculate the tick spacing. FALSE if the layer uses the manually set values.

See also:: setAutoTickSpacing()

virtual void LatLonLayer::setFont ( const Font & font ) [pure virtual]

Sets the font for the latitude/longitude text.

Parameters:

font

The new latitude/longitude font.

Subject Notifications:: This method will notify Subject::signalModified().

virtual const Font& LatLonLayer::getFont ( ) const [pure virtual]

Returns read-only access to the latitude/longitude text font.

Returns:: The current latitude/longitude text font. To modify the font values, call setFont() instead.

virtual void LatLonLayer::setGeocoordType ( const GeocoordType & system ) [pure virtual]

Sets the displayed geocoordinate system.

If auto spacing is not enabled, setTickSpacing() should be called to specify the tick spacing in the geocoordinate system.

Parameters:

system

The geocoordinate system used for display.

Subject Notifications:: This method will notify Subject::signalModified.

See also:: GeocoordType

virtual GeocoordType LatLonLayer::getGeocoordType ( ) const [pure virtual]

Returns the geocoordinate system used for display.

Returns:: The geocoordinate system.

See also:: GeocoordType

virtual void LatLonLayer::setLatLonFormat ( const DmsFormatType & eFormat ) [pure virtual]

Sets the display format for latitude/longitude values.

This method sets the display format for latitude longitude values. It can still be called when the current geocoordinate system is not latitude/longitude, and will take effect when the user updates the view to display latitude/longitude values.

Parameters:

eFormat

The latitude/longitude display format.

Subject Notifications:: This method will notify Subject::signalModified.

See also:: DmsFormatType, getGeocoordType()

virtual DmsFormatType LatLonLayer::getLatLonFormat ( ) const [pure virtual]

Returns the display format of latitude/longitude values.

Returns:: The latitude/longitude display format. This value will be valid even if the currently displayed geocoordinate system is not latitude/longitude.

See also:: DmsFormatType, getGeocoordType()


Public Member Functions
virtual void	setColor (const ColorType &colorType)=0
virtual ColorType	getColor () const =0
virtual void	setStyle (const LatLonStyle &eStyle)=0
virtual LatLonStyle	getStyle () const =0
virtual void	setWidth (unsigned int width)=0
virtual unsigned int	getWidth () const =0
virtual void	setTickSpacing (const LocationType &spacing)=0
virtual LocationType	getTickSpacing () const =0
virtual void	setAutoTickSpacing (bool bAutoSpacing)=0
virtual bool	getAutoTickSpacing () const =0
virtual void	setFont (const Font &font)=0
virtual const Font &	getFont () const =0
virtual void	setGeocoordType (const GeocoordType &system)=0
virtual GeocoordType	getGeocoordType () const =0
virtual void	setLatLonFormat (const DmsFormatType &eFormat)=0
virtual DmsFormatType	getLatLonFormat () const =0
Static Public Member Functions
static std::string	getSettingFont ()
static bool	hasSettingFont ()
static void	setSettingFont (std::string newValue, bool setIfSame=false)
static std::string	getSettingFontKey ()
static unsigned int	getSettingFontSize ()
static bool	hasSettingFontSize ()
static void	setSettingFontSize (unsigned int newValue, bool setIfSame=false)
static std::string	getSettingFontSizeKey ()
static ColorType	getSettingGridlineColor ()
static bool	hasSettingGridlineColor ()
static void	setSettingGridlineColor (ColorType newValue, bool setIfSame=false)
static std::string	getSettingGridlineColorKey ()
static LatLonStyle	getSettingGridlineStyle ()
static bool	hasSettingGridlineStyle ()
static void	setSettingGridlineStyle (LatLonStyle newValue, bool setIfSame=false)
static std::string	getSettingGridlineStyleKey ()
static unsigned int	getSettingGridlineWidth ()
static bool	hasSettingGridlineWidth ()
static void	setSettingGridlineWidth (unsigned int newValue, bool setIfSame=false)
static std::string	getSettingGridlineWidthKey ()
static const std::string &	signalFormatChanged ()
static const std::string &	signalColorChanged ()
static const std::string &	signalFontChanged ()
static const std::string &	signalStyleChanged ()
static const std::string &	signalWidthChanged ()
static const std::string &	signalTickSpacingChanged ()
static const std::string &	signalAutoTickSpacingChanged ()
static const std::string &	signalCoordTypeChanged ()
Protected Member Functions
virtual	~LatLonLayer ()