a CoordinateConversionOption
is a collection of properties that dictates how a Point
should be converted to and from a string. More...
Header | #include <Coordinate |
Inherits | Q |
Public Types
enum | Coordinate |
Properties
|
|
Public Functions
Coordinate | |
virtual | ~ |
int | decimal |
Esri | gars |
bool | has |
Esri | lat |
Esri | mgrs |
Q | name() const |
Esri | output |
Esri | point |
int | precision() const |
Q | pretty |
void | set |
void | set |
void | set |
void | set |
void | set |
void | set |
void | set |
void | set |
void | set |
Esri | utm |
Signals
void | decimal |
void | gars |
void | has |
void | lat |
void | mgrs |
void | name |
void | output |
void | precision |
void | utm |
Detailed Description
A CoordinateConversionOption
is able to convert between Point and QString using the formatting options it is currently set with.
Member Type Documentation
enum CoordinateConversionOption::CoordinateType
The target coordinate output format.
Constant | Value | Description |
---|---|---|
Esri | 0 | Output format is GAR |
Esri | 1 | Output format is Geo |
Esri | 2 | Output format is Lat |
Esri | 3 | Output format is MGR |
Esri | 4 | Output format is USG |
Esri | 5 | Output format is UT |
Property Documentation
decimalPlaces : int
Access functions:
int | decimal |
void | set |
Notifier signal:
void | decimal |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::decimalPlaces().
garsConversionMode : GarsConversionMode
Access functions:
Esri | gars |
void | set |
Notifier signal:
void | gars |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::garsConversionMode().
hasSpaces : bool
Access functions:
bool | has |
void | set |
Notifier signal:
void | has |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::hasSpaces().
latLonFormat : LatitudeLongitudeFormat
Access functions:
Esri | lat |
void | set |
Notifier signal:
void | lat |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::latLonFormat().
mgrsConversionMode : MgrsConversionMode
Access functions:
Esri | mgrs |
void | set |
Notifier signal:
void | mgrs |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::mgrsConversionMode().
name : QString
Access functions:
Notifier signal:
void | name |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::name().
outputMode : CoordinateType
Access functions:
Esri | output |
void | set |
Notifier signal:
void | output |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::outputMode().
precision : int
Access functions:
int | precision() const |
void | set |
Notifier signal:
void | precision |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::precision().
utmConversionMode : UtmConversionMode
Access functions:
Esri | utm |
void | set |
Notifier signal:
void | utm |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::utmConversionMode().
Member Function Documentation
CoordinateConversionOption::CoordinateConversionOption (QObject *parent = nullptr)
Constructor
- parent Owning parent QObject.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
[signal]
void CoordinateConversionOption::decimalPlacesChanged ()
Emits when decimal
property changes.
Note: Notifier signal for property decimalPlaces.
[signal]
void CoordinateConversionOption::garsConversionModeChanged ()
Emits when garsConversionMode
property changes.
Note: Notifier signal for property garsConversionMode.
[signal]
void CoordinateConversionOption::hasSpacesChanged ()
Emits when hasSpaces
property changes.
Note: Notifier signal for property hasSpaces.
[signal]
void CoordinateConversionOption::latLonFormatChanged ()
Emits when latLonFormat
property changes.
Note: Notifier signal for property latLonFormat.
[signal]
void CoordinateConversionOption::mgrsConversionModeChanged ()
Emits when mgrsConversion
property changes.
Note: Notifier signal for property mgrsConversionMode.
[signal]
void CoordinateConversionOption::nameChanged ()
Emits when name
property changes.
Note: Notifier signal for property name.
[signal]
void CoordinateConversionOption::outputModeChanged ()
Emits when outputMode
property changes.
Note: Notifier signal for property outputMode.
[signal]
void CoordinateConversionOption::precisionChanged ()
Emits when precision
property changes.
Note: Notifier signal for property precision.
[signal]
void CoordinateConversionOption::utmConversionModeChanged ()
Emits when utmConversionMode
property changes.
Note: Notifier signal for property utmConversionMode.
[override virtual]
CoordinateConversionOption::~CoordinateConversionOption ()
The destructor.
int CoordinateConversionOption::decimalPlaces () const
Returns the number of decimal spaces in the format (if applicable).
Note: Getter function for property decimalPlaces.
See also setDecimalPlaces().
Esri::ArcGISRuntime::GarsConversionMode CoordinateConversionOption::garsConversionMode () const
Returns the GARS conversion mode (if applicable).
Note: Getter function for property garsConversionMode.
See also setGarsConversionMode().
bool CoordinateConversionOption::hasSpaces () const
Returns flag whether to add spaces in notation (if applicable).
Note: Getter function for property hasSpaces.
See also setHasSpaces().
Esri::ArcGISRuntime::LatitudeLongitudeFormat CoordinateConversionOption::latLonFormat () const
Returns the Latitude and Longitude format (if applicable).
Note: Getter function for property latLonFormat.
See also setLatLonFormat().
Esri::ArcGISRuntime::MgrsConversionMode CoordinateConversionOption::mgrsConversionMode () const
Returns the MGRS conversion mode (if applicable).
Note: Getter function for property mgrsConversionMode.
See also setMgrsConversionMode().
QString CoordinateConversionOption::name() const
Returns the user friendly name of this option.
Note: Getter function for property name.
See also setName().
Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::CoordinateType CoordinateConversionOption::outputMode () const
Returns the conversion type of this option.
Note: Getter function for property outputMode.
See also setOutputMode().
Esri::ArcGISRuntime::Point CoordinateConversionOption::pointFromString (const QString &point, const Esri::ArcGISRuntime::SpatialReference &spatialReference )
Given a string called point, converts it to a Point
using the current formatting options applied.
This conversion has the chance of failing, in which case an invalid default-constructed Point will be returned.
- point
QString
to convert to aPoint
. - spatialReference
SpatialReference
to use in conversion.
Returns the string as a Point
.
int CoordinateConversionOption::precision() const
Returns precision of conversion format (if applicable).
Note: Getter function for property precision.
See also setPrecision().
QString CoordinateConversionOption::prettyPrint (const Esri::ArcGISRuntime::Point &point) const
Converts a Point
to a QString
based on the properties set in this CoordinateConversionOption
.
- point
Point
to convert toQString
.
Returns a representation of point with the current formatting options applied.
void CoordinateConversionOption::setDecimalPlaces (int decimalPlaces )
Set decimalPlaces
to decimalPlaces.
Note: Setter function for property decimalPlaces.
See also decimalPlaces().
void CoordinateConversionOption::setGarsConversionMode (Esri::ArcGISRuntime::GarsConversionMode conversionMode )
Sets garsConversionMode
to conversionMode.
Note: Setter function for property garsConversionMode.
See also garsConversionMode().
void CoordinateConversionOption::setHasSpaces (bool hasSpaces )
Set hasSpaces
to hasSpaces.
Note: Setter function for property hasSpaces.
See also hasSpaces().
void CoordinateConversionOption::setLatLonFormat (Esri::ArcGISRuntime::LatitudeLongitudeFormat latLonFormat )
Sets latLonFormat
to latLonFormat.
Note: Setter function for property latLonFormat.
See also latLonFormat().
void CoordinateConversionOption::setMgrsConversionMode (Esri::ArcGISRuntime::MgrsConversionMode mgrsConversionMode )
Set mgrsConversionMode
to mgrsConversionMode.
Note: Setter function for property mgrsConversionMode.
See also mgrsConversionMode().
void CoordinateConversionOption::setName (const QString &name)
Set name
to name.
Note: Setter function for property name.
See also name().
void CoordinateConversionOption::setOutputMode (Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::CoordinateType outputMode )
Sets the conversion type to outputMode.
Note: Setter function for property outputMode.
See also outputMode().
void CoordinateConversionOption::setPrecision (int precision)
Set precision
to precision.
Note: Setter function for property precision.
See also precision().
void CoordinateConversionOption::setUtmConversionMode (Esri::ArcGISRuntime::UtmConversionMode utmConversionMode )
Sets utmConversionMode
to utmConversionMode.
Note: Setter function for property utmConversionMode.
See also utmConversionMode().
Esri::ArcGISRuntime::UtmConversionMode CoordinateConversionOption::utmConversionMode () const
Returns the UTM conversion mode (if applicable).
Note: Getter function for property utmConversionMode.
See also setUtmConversionMode().