GeographicLib
1.35
|
Conversion between geographic coordinates. More...
#include <GeographicLib/GeoCoords.hpp>
Public Member Functions | |
Initializing the GeoCoords object | |
GeoCoords () throw () | |
GeoCoords (const std::string &s, bool centerp=true, bool swaplatlong=false) | |
GeoCoords (real latitude, real longitude, int zone=UTMUPS::STANDARD) | |
GeoCoords (int zone, bool northp, real easting, real northing) | |
void | Reset (const std::string &s, bool centerp=true, bool swaplatlong=false) |
void | Reset (real latitude, real longitude, int zone=UTMUPS::STANDARD) |
void | Reset (int zone, bool northp, real easting, real northing) |
Querying the GeoCoords object | |
Math::real | Latitude () const throw () |
Math::real | Longitude () const throw () |
Math::real | Easting () const throw () |
Math::real | Northing () const throw () |
Math::real | Convergence () const throw () |
Math::real | Scale () const throw () |
bool | Northp () const throw () |
char | Hemisphere () const throw () |
int | Zone () const throw () |
Setting and querying the alternate zone | |
void | SetAltZone (int zone=UTMUPS::STANDARD) const |
int | AltZone () const throw () |
Math::real | AltEasting () const throw () |
Math::real | AltNorthing () const throw () |
Math::real | AltConvergence () const throw () |
Math::real | AltScale () const throw () |
String representations of the GeoCoords object | |
std::string | GeoRepresentation (int prec=0, bool swaplatlong=false) const |
std::string | DMSRepresentation (int prec=0, bool swaplatlong=false, char dmssep=char(0)) const |
std::string | MGRSRepresentation (int prec=0) const |
std::string | UTMUPSRepresentation (int prec=0) const |
std::string | UTMUPSRepresentation (bool northp, int prec=0) const |
std::string | AltMGRSRepresentation (int prec=0) const |
std::string | AltUTMUPSRepresentation (int prec=0) const |
std::string | AltUTMUPSRepresentation (bool northp, int prec=0) const |
Inspector functions | |
Math::real | MajorRadius () const throw () |
Math::real | Flattening () const throw () |
Conversion between geographic coordinates.
This class stores a geographic position which may be set via the constructors or Reset via
The state consists of the latitude and longitude and the supplied UTM or UPS coordinates (possibly derived from the MGRS coordinates). If latitude and longitude were given then the UTM/UPS coordinates follows the standard conventions.
The mutable state consists of the UTM or UPS coordinates for a alternate zone. A method SetAltZone is provided to set the alternate UPS/UTM zone.
Methods are provided to return the geographic coordinates, the input UTM or UPS coordinates (and associated meridian convergence and scale), or alternate UTM or UPS coordinates (and their associated meridian convergence and scale).
Once the input string has been parsed, you can print the result out in any of the formats, decimal degrees, degrees minutes seconds, MGRS, UTM/UPS.
Example of use:
GeoConvert is a command-line utility providing access to the functionality of GeoCoords.
Definition at line 49 of file GeoCoords.hpp.
|
inline |
The default constructor is equivalent to latitude = 90°, longitude = 0°.
Definition at line 77 of file GeoCoords.hpp.
|
inlineexplicit |
Construct from a string.
[in] | s | 1-element, 2-element, or 3-element string representation of the position. |
[in] | centerp | governs the interpretation of MGRS coordinates (see below). |
[in] | swaplatlong | governs the interpretation of geographic coordinates (see below). |
GeographicErr | if the s is malformed (see below). |
Parse as a string and interpret it as a geographic position. The input string is broken into space (or comma) separated pieces and Basic decision on which format is based on number of components
The following inputs are approximately the same (Ar Ramadi Bridge, Iraq)
Latitude and Longitude parsing: Latitude precedes longitude, unless a N, S, E, W hemisphere designator is used on one or both coordinates. If swaplatlong = true (default is false), then longitude precedes latitude in the absence of a hemisphere designator. Thus (with swaplatlong = false)
are all the same position. The coordinates may be given in decimal degrees, degrees and decimal minutes, degrees, minutes, seconds, etc. Use d, ', and " to mark off the degrees, minutes and seconds. Various alternative symbols for degrees, minutes, and seconds are allowed. Alternatively, use : to separate these components. (See DMS::Decode for details.) Thus
all specify the same angle. The leading sign applies to all components so -1d30 is -(1+30/60) = -1.5. Latitudes must be in the range [−90°, 90°] and longitudes in the range [−540°, 540°). Internally longitudes are reduced to the range [−180°, 180°).
UTM/UPS parsing: For UTM zones (−80° ≤ Lat < 84°), the zone designator is made up of a zone number (for 1 to 60) and a hemisphere letter (N or S), e.g., 38N. The latitude zone designer ([C–M] in the southern hemisphere and [N–X] in the northern) should NOT be used. (This is part of the MGRS coordinate.) The zone designator for the poles (where UPS is employed) is a hemisphere letter by itself, i.e., N or S.
MGRS parsing interprets the grid references as square area at the specified precision (1m, 10m, 100m, etc.). If centerp = true (the default), the center of this square is then taken to be the precise position; thus:
Otherwise, the "south-west" corner of the square is used, i.e.,
Definition at line 173 of file GeoCoords.hpp.
|
inline |
Construct from geographic coordinates.
[in] | latitude | (degrees). |
[in] | longitude | (degrees). |
[in] | zone | if specified, force the UTM/UPS representation to use a specified zone using the rules given in UTMUPS::zonespec. |
GeographicErr | if latitude is not in [−90°, 90°]. |
GeographicErr | if longitude is not in [−540°, 540°). |
GeographicErr | if zone cannot be used for this location. |
Definition at line 190 of file GeoCoords.hpp.
|
inline |
Construct from UTM/UPS coordinates.
[in] | zone | UTM zone (zero means UPS). |
[in] | northp | hemisphere (true means north, false means south). |
[in] | easting | (meters). |
[in] | northing | (meters). |
GeographicErr | if zone, easting, or northing is outside its allowed range. |
Definition at line 204 of file GeoCoords.hpp.
void GeographicLib::GeoCoords::Reset | ( | const std::string & | s, |
bool | centerp = true , |
||
bool | swaplatlong = false |
||
) |
Reset the location from a string. See GeoCoords(const std::string& s, bool centerp, bool swaplatlong).
[in] | s | 1-element, 2-element, or 3-element string representation of the position. |
[in] | centerp | governs the interpretation of MGRS coordinates. |
[in] | swaplatlong | governs the interpretation of geographic coordinates. |
GeographicErr | if the s is malformed. |
Definition at line 18 of file GeoCoords.cpp.
References GeographicLib::DMS::Decode(), GeographicLib::DMS::DecodeLatLon(), GeographicLib::UTMUPS::DecodeZone(), GeographicLib::UTMUPS::Forward(), GeographicLib::UTMUPS::Reverse(), and GeographicLib::MGRS::Reverse().
Referenced by main().
|
inline |
Reset the location in terms of geographic coordinates. See GeoCoords(real latitude, real longitude, int zone).
[in] | latitude | (degrees). |
[in] | longitude | (degrees). |
[in] | zone | if specified, force the UTM/UPS representation to use a specified zone using the rules given in UTMUPS::zonespec. |
GeographicErr | if latitude is not in [−90°, 90°]. |
GeographicErr | if longitude is not in [−540°, 540°). |
GeographicErr | if zone cannot be used for this location. |
Definition at line 236 of file GeoCoords.hpp.
References GeographicLib::UTMUPS::Forward().
|
inline |
Reset the location in terms of UPS/UPS coordinates. See GeoCoords(int zone, bool northp, real easting, real northing).
[in] | zone | UTM zone (zero means UPS). |
[in] | northp | hemisphere (true means north, false means south). |
[in] | easting | (meters). |
[in] | northing | (meters). |
GeographicErr | if zone, easting, or northing is outside its allowed range. |
Definition at line 258 of file GeoCoords.hpp.
References GeographicLib::UTMUPS::Reverse().
|
inline |
|
inline |
|
inline |
Definition at line 286 of file GeoCoords.hpp.
|
inline |
Definition at line 291 of file GeoCoords.hpp.
|
inline |
Definition at line 296 of file GeoCoords.hpp.
|
inline |
Definition at line 301 of file GeoCoords.hpp.
|
inline |
Definition at line 306 of file GeoCoords.hpp.
|
inline |
Definition at line 311 of file GeoCoords.hpp.
|
inline |
Definition at line 316 of file GeoCoords.hpp.
|
inline |
Specify alternate zone number.
[in] | zone | zone number for the alternate representation. |
GeographicErr | if zone cannot be used for this location. |
See UTMUPS::zonespec for more information on the interpretation of zone. Note that zone == UTMUPS::STANDARD (the default) use the standard UPS or UTM zone, UTMUPS::MATCH does nothing retaining the existing alternate representation. Before this is called the alternate zone is the input zone.
Definition at line 335 of file GeoCoords.hpp.
References GeographicLib::UTMUPS::Forward(), GeographicLib::UTMUPS::MATCH, and GeographicLib::UTMUPS::StandardZone().
|
inline |
Definition at line 353 of file GeoCoords.hpp.
|
inline |
Definition at line 358 of file GeoCoords.hpp.
|
inline |
Definition at line 363 of file GeoCoords.hpp.
|
inline |
Definition at line 368 of file GeoCoords.hpp.
|
inline |
Definition at line 373 of file GeoCoords.hpp.
string GeographicLib::GeoCoords::GeoRepresentation | ( | int | prec = 0 , |
bool | swaplatlong = false |
||
) | const |
String representation with latitude and longitude as signed decimal degrees.
[in] | prec | precision (relative to about 1m). |
[in] | swaplatlong | if true give longitude first (default = false) |
std::bad_alloc | if memory for the string can't be allocated. |
Precision specifies accuracy of representation as follows:
Definition at line 60 of file GeoCoords.cpp.
References GeographicLib::Math::extradigits, and GeographicLib::Math::isnan().
string GeographicLib::GeoCoords::DMSRepresentation | ( | int | prec = 0 , |
bool | swaplatlong = false , |
||
char | dmssep = char(0) |
||
) | const |
String representation with latitude and longitude as degrees, minutes, seconds, and hemisphere.
[in] | prec | precision (relative to about 1m) |
[in] | swaplatlong | if true give longitude first (default = false) |
[in] | dmssep | if non-null, use as the DMS separator character (instead of d, ', " delimiters). |
std::bad_alloc | if memory for the string can't be allocated. |
Precision specifies accuracy of representation as follows:
Definition at line 78 of file GeoCoords.cpp.
References GeographicLib::DMS::Encode(), GeographicLib::Math::extradigits, GeographicLib::DMS::LATITUDE, and GeographicLib::DMS::LONGITUDE.
string GeographicLib::GeoCoords::MGRSRepresentation | ( | int | prec = 0 | ) | const |
MGRS string.
[in] | prec | precision (relative to about 1m). |
std::bad_alloc | if memory for the string can't be allocated. |
This gives the coordinates of the enclosing grid square with size given by the precision. Thus 38N 444180 3684790 converted to a MGRS coordinate at precision −2 (100m) is 38SMB441847 and not 38SMB442848. prec specifies the precision of the MGRS string as follows:
Definition at line 87 of file GeoCoords.cpp.
References GeographicLib::MGRS::Forward().
string GeographicLib::GeoCoords::UTMUPSRepresentation | ( | int | prec = 0 | ) | const |
UTM/UPS string.
[in] | prec | precision (relative to about 1m) |
std::bad_alloc | if memory for the string can't be allocated. |
Precision specifies accuracy of representation as follows:
Definition at line 126 of file GeoCoords.cpp.
string GeographicLib::GeoCoords::UTMUPSRepresentation | ( | bool | northp, |
int | prec = 0 |
||
) | const |
UTM/UPS string with hemisphere override.
[in] | prec | precision (relative to about 1m) |
[in] | northp | hemisphere override |
GeographicErr | if the hemisphere override attempts to change UPS N to UPS S or vice verse. |
std::bad_alloc | if memory for the string can't be allocated. |
Definition at line 132 of file GeoCoords.cpp.
References GeographicLib::UTMUPS::Transfer().
string GeographicLib::GeoCoords::AltMGRSRepresentation | ( | int | prec = 0 | ) | const |
MGRS string for the alternate zone. See GeoCoords::MGRSRepresentation.
[in] | prec | precision (relative to about 1m). |
std::bad_alloc | if memory for the string can't be allocated. |
Definition at line 95 of file GeoCoords.cpp.
References GeographicLib::MGRS::Forward().
string GeographicLib::GeoCoords::AltUTMUPSRepresentation | ( | int | prec = 0 | ) | const |
UTM/UPS string for the alternate zone. See GeoCoords::UTMUPSRepresentation.
[in] | prec | precision (relative to about 1m) |
std::bad_alloc | if memory for the string can't be allocated. |
Definition at line 142 of file GeoCoords.cpp.
string GeographicLib::GeoCoords::AltUTMUPSRepresentation | ( | bool | northp, |
int | prec = 0 |
||
) | const |
UTM/UPS string for the alternate zone, with hemisphere override.
[in] | prec | precision (relative to about 1m) |
[in] | northp | hemisphere override |
GeographicErr | if the hemisphere override attempts to change UPS N to UPS S or vice verse. |
std::bad_alloc | if memory for the string can't be allocated. |
Definition at line 148 of file GeoCoords.cpp.
References GeographicLib::UTMUPS::Transfer().
|
inline |
(The WGS84 value is returned because the UTM and UPS projections are based on this ellipsoid.)
Definition at line 518 of file GeoCoords.hpp.
References GeographicLib::UTMUPS::MajorRadius().
|
inline |
(The WGS84 value is returned because the UTM and UPS projections are based on this ellipsoid.)
Definition at line 526 of file GeoCoords.hpp.
References GeographicLib::UTMUPS::Flattening().