a CoordinateConversionOption is a collection of properties that dictates how a Point should be converted to and from a string. More...
| Header: | #include <CoordinateConversionOption> |
| Inherits: | QObject |
Public Types
| enum | CoordinateType { Gars, GeoRef, LatLon, Mgrs, Usng, Utm } |
Properties
|
|
Public Functions
| CoordinateConversionOption(QObject *parent = nullptr) | |
| virtual | ~CoordinateConversionOption() override |
| int | decimalPlaces() const |
| Esri::ArcGISRuntime::GarsConversionMode | garsConversionMode() const |
| bool | hasSpaces() const |
| Esri::ArcGISRuntime::LatitudeLongitudeFormat | latLonFormat() const |
| Esri::ArcGISRuntime::MgrsConversionMode | mgrsConversionMode() const |
| QString | name() const |
| Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::CoordinateType | outputMode() const |
| Esri::ArcGISRuntime::Point | pointFromString(const QString &point, const Esri::ArcGISRuntime::SpatialReference &spatialReference) |
| int | precision() const |
| QString | prettyPrint(const Esri::ArcGISRuntime::Point &point) const |
| void | setDecimalPlaces(int decimalPlaces) |
| void | setGarsConversionMode(Esri::ArcGISRuntime::GarsConversionMode conversionMode) |
| void | setHasSpaces(bool hasSpaces) |
| void | setLatLonFormat(Esri::ArcGISRuntime::LatitudeLongitudeFormat latLonFormat) |
| void | setMgrsConversionMode(Esri::ArcGISRuntime::MgrsConversionMode mgrsConversionMode) |
| void | setName(const QString &name) |
| void | setOutputMode(Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::CoordinateType outputMode) |
| void | setPrecision(int precision) |
| void | setUtmConversionMode(Esri::ArcGISRuntime::UtmConversionMode utmConversionMode) |
| Esri::ArcGISRuntime::UtmConversionMode | utmConversionMode() const |
Signals
| void | decimalPlacesChanged() |
| void | garsConversionModeChanged() |
| void | hasSpacesChanged() |
| void | latLonFormatChanged() |
| void | mgrsConversionModeChanged() |
| void | nameChanged() |
| void | outputModeChanged() |
| void | precisionChanged() |
| void | utmConversionModeChanged() |
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::ArcGISRuntime::Toolkit::CoordinateConversionOption::Gars | 0 | Output format is GARS. |
Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::GeoRef | 1 | Output format is GeoRef. |
Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::LatLon | 2 | Output format is LatLon. |
Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::Mgrs | 3 | Output format is MGRS. |
Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::Usng | 4 | Output format is USGN. |
Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::Utm | 5 | Output format is UTM. |
Property Documentation
decimalPlaces : int
Access functions:
| int | decimalPlaces() const |
| void | setDecimalPlaces(int decimalPlaces) |
Notifier signal:
| void | decimalPlacesChanged() |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::decimalPlaces().
garsConversionMode : GarsConversionMode
Access functions:
| Esri::ArcGISRuntime::GarsConversionMode | garsConversionMode() const |
| void | setGarsConversionMode(Esri::ArcGISRuntime::GarsConversionMode conversionMode) |
Notifier signal:
| void | garsConversionModeChanged() |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::garsConversionMode().
hasSpaces : bool
Access functions:
| bool | hasSpaces() const |
| void | setHasSpaces(bool hasSpaces) |
Notifier signal:
| void | hasSpacesChanged() |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::hasSpaces().
latLonFormat : LatitudeLongitudeFormat
Access functions:
| Esri::ArcGISRuntime::LatitudeLongitudeFormat | latLonFormat() const |
| void | setLatLonFormat(Esri::ArcGISRuntime::LatitudeLongitudeFormat latLonFormat) |
Notifier signal:
| void | latLonFormatChanged() |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::latLonFormat().
mgrsConversionMode : MgrsConversionMode
Access functions:
| Esri::ArcGISRuntime::MgrsConversionMode | mgrsConversionMode() const |
| void | setMgrsConversionMode(Esri::ArcGISRuntime::MgrsConversionMode mgrsConversionMode) |
Notifier signal:
| void | mgrsConversionModeChanged() |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::mgrsConversionMode().
name : QString
Access functions:
Notifier signal:
| void | nameChanged() |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::name().
outputMode : CoordinateType
Access functions:
| Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::CoordinateType | outputMode() const |
| void | setOutputMode(Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::CoordinateType outputMode) |
Notifier signal:
| void | outputModeChanged() |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::outputMode().
precision : int
Access functions:
| int | precision() const |
| void | setPrecision(int precision) |
Notifier signal:
| void | precisionChanged() |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::precision().
utmConversionMode : UtmConversionMode
Access functions:
| Esri::ArcGISRuntime::UtmConversionMode | utmConversionMode() const |
| void | setUtmConversionMode(Esri::ArcGISRuntime::UtmConversionMode utmConversionMode) |
Notifier signal:
| void | utmConversionModeChanged() |
See also Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::utmConversionMode().
Member Function Documentation
[invokable] 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.
[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().
[signal] void CoordinateConversionOption::decimalPlacesChanged ()
Emits when decimal property changes.
Note: Notifier signal for property decimalPlaces.
Esri::ArcGISRuntime::GarsConversionMode CoordinateConversionOption::garsConversionMode () const
Returns the GARS conversion mode (if applicable).
Note: Getter function for property garsConversionMode.
See also setGarsConversionMode().
[signal] void CoordinateConversionOption::garsConversionModeChanged ()
Emits when garsConversionMode property changes.
Note: Notifier signal for property garsConversionMode.
bool CoordinateConversionOption::hasSpaces () const
Returns flag whether to add spaces in notation (if applicable).
Note: Getter function for property hasSpaces.
See also setHasSpaces().
[signal] void CoordinateConversionOption::hasSpacesChanged ()
Emits when hasSpaces property changes.
Note: Notifier signal for property hasSpaces.
Esri::ArcGISRuntime::LatitudeLongitudeFormat CoordinateConversionOption::latLonFormat () const
Returns the Latitude and Longitude format (if applicable).
Note: Getter function for property latLonFormat.
See also setLatLonFormat().
[signal] void CoordinateConversionOption::latLonFormatChanged ()
Emits when latLonFormat property changes.
Note: Notifier signal for property latLonFormat.
Esri::ArcGISRuntime::MgrsConversionMode CoordinateConversionOption::mgrsConversionMode () const
Returns the MGRS conversion mode (if applicable).
Note: Getter function for property mgrsConversionMode.
See also setMgrsConversionMode().
[signal] void CoordinateConversionOption::mgrsConversionModeChanged ()
Emits when mgrsConversion property changes.
Note: Notifier signal for property mgrsConversionMode.
QString CoordinateConversionOption::name() const
Returns the user friendly name of this option.
Note: Getter function for property name.
See also setName().
[signal] void CoordinateConversionOption::nameChanged ()
Emits when name property changes.
Note: Notifier signal for property name.
Esri::ArcGISRuntime::Toolkit::CoordinateConversionOption::CoordinateType CoordinateConversionOption::outputMode () const
Returns the conversion type of this option.
Note: Getter function for property outputMode.
See also setOutputMode().
[signal] void CoordinateConversionOption::outputModeChanged ()
Emits when outputMode property changes.
Note: Notifier signal for property outputMode.
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
QStringto convert to aPoint. - spatialReference
SpatialReferenceto 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().
[signal] void CoordinateConversionOption::precisionChanged ()
Emits when precision property changes.
Note: Notifier signal for property precision.
QString CoordinateConversionOption::prettyPrint (const Esri::ArcGISRuntime::Point &point) const
Converts a Point to a QString based on the properties set in this CoordinateConversionOption.
- point
Pointto 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().
[signal] void CoordinateConversionOption::utmConversionModeChanged ()
Emits when utmConversionMode property changes.
Note: Notifier signal for property utmConversionMode.