Conversion between geographic coordinates. More...
#include <GeoCoords.hpp>
Public Member Functions | |
Initializing the GeoCoords object | |
GeoCoords () | |
GeoCoords (const std::string &s, bool centerp=true, bool longfirst=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 longfirst=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 |
Math::real | Longitude () const |
Math::real | Easting () const |
Math::real | Northing () const |
Math::real | Convergence () const |
Math::real | Scale () const |
bool | Northp () const |
char | Hemisphere () const |
int | Zone () const |
Setting and querying the alternate zone | |
void | SetAltZone (int zone=UTMUPS::STANDARD) const |
int | AltZone () const |
Math::real | AltEasting () const |
Math::real | AltNorthing () const |
Math::real | AltConvergence () const |
Math::real | AltScale () const |
String representations of the GeoCoords object | |
std::string | GeoRepresentation (int prec=0, bool longfirst=false) const |
std::string | DMSRepresentation (int prec=0, bool longfirst=false, char dmssep=char(0)) const |
std::string | MGRSRepresentation (int prec=0) const |
std::string | UTMUPSRepresentation (int prec=0, bool abbrev=true) const |
std::string | UTMUPSRepresentation (bool northp, int prec=0, bool abbrev=true) const |
std::string | AltMGRSRepresentation (int prec=0) const |
std::string | AltUTMUPSRepresentation (int prec=0, bool abbrev=true) const |
std::string | AltUTMUPSRepresentation (bool northp, int prec=0, bool abbrev=true) const |
Inspector functions | |
Math::real | MajorRadius () const |
Math::real | Flattening () const |
Private Types | |
typedef Math::real | real |
Private Member Functions | |
void | CopyToAlt () const |
void | FixHemisphere () |
Static Private Member Functions | |
static void | UTMUPSString (int zone, bool northp, real easting, real northing, int prec, bool abbrev, std::string &utm) |
Private Attributes | |
real | _alt_easting |
real | _alt_gamma |
real | _alt_k |
real | _alt_northing |
int | _alt_zone |
real | _easting |
real | _gamma |
real | _k |
real | _lat |
real | _long |
real | _northing |
bool | _northp |
int | _zone |
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.
|
private |
Definition at line 51 of file GeoCoords.hpp.
|
inline |
The default constructor sets the coordinate as undefined.
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] | longfirst | 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 longfirst = true (default is false), then longitude precedes latitude in the absence of a hemisphere designator. Thus (with longfirst = 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. A single addition or subtraction is allowed. (See DMS::Decode for details.) Thus
all specify the same angle. The leading sign applies to the following components so -1d30 is -(1+30/60) = −1.5. However, note that -1:30-0:0:15 is parsed as (-1:30) + (-0:0:15) = −(1+30/60) − (15/3600). Latitudes must be in the range [−90°, 90°]. 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 (38north can also be used). The latitude band 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 (north or south can also be used).
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 179 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 zone cannot be used for this location. |
Definition at line 194 of file GeoCoords.hpp.
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 208 of file GeoCoords.hpp.
|
inline |
Definition at line 370 of file GeoCoords.hpp.
|
inline |
Definition at line 360 of file GeoCoords.hpp.
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 97 of file src/GeoCoords.cpp.
|
inline |
Definition at line 365 of file GeoCoords.hpp.
|
inline |
Definition at line 375 of file GeoCoords.hpp.
string GeographicLib::GeoCoords::AltUTMUPSRepresentation | ( | bool | northp, |
int | prec = 0 , |
||
bool | abbrev = true |
||
) | const |
UTM/UPS string for the alternate zone, with hemisphere override.
[in] | northp | hemisphere override |
[in] | prec | precision (relative to about 1m) |
[in] | abbrev | if true (the default) use abbreviated (n/s) notation for hemisphere; otherwise spell out the hemisphere (north/south) |
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 153 of file src/GeoCoords.cpp.
string GeographicLib::GeoCoords::AltUTMUPSRepresentation | ( | int | prec = 0 , |
bool | abbrev = true |
||
) | const |
UTM/UPS string for the alternate zone. See GeoCoords::UTMUPSRepresentation.
[in] | prec | precision (relative to about 1m) |
[in] | abbrev | if true (the default) use abbreviated (n/s) notation for hemisphere; otherwise spell out the hemisphere (north/south) |
std::bad_alloc | if memory for the string can't be allocated. |
Definition at line 146 of file src/GeoCoords.cpp.
|
inline |
Definition at line 355 of file GeoCoords.hpp.
|
inline |
Definition at line 298 of file GeoCoords.hpp.
|
inlineprivate |
Definition at line 58 of file GeoCoords.hpp.
string GeographicLib::GeoCoords::DMSRepresentation | ( | int | prec = 0 , |
bool | longfirst = 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] | longfirst | 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 80 of file src/GeoCoords.cpp.
|
inline |
Definition at line 288 of file GeoCoords.hpp.
|
private |
Definition at line 164 of file src/GeoCoords.cpp.
|
inline |
(The WGS84 value is returned because the UTM and UPS projections are based on this ellipsoid.)
Definition at line 540 of file GeoCoords.hpp.
string GeographicLib::GeoCoords::GeoRepresentation | ( | int | prec = 0 , |
bool | longfirst = false |
||
) | const |
String representation with latitude and longitude as signed decimal degrees.
[in] | prec | precision (relative to about 1m). |
[in] | longfirst | 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 62 of file src/GeoCoords.cpp.
|
inline |
Definition at line 313 of file GeoCoords.hpp.
|
inline |
Definition at line 278 of file GeoCoords.hpp.
|
inline |
Definition at line 283 of file GeoCoords.hpp.
|
inline |
(The WGS84 value is returned because the UTM and UPS projections are based on this ellipsoid.)
Definition at line 532 of file GeoCoords.hpp.
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 89 of file src/GeoCoords.cpp.
|
inline |
Definition at line 293 of file GeoCoords.hpp.
|
inline |
Definition at line 308 of file GeoCoords.hpp.
void GeographicLib::GeoCoords::Reset | ( | const std::string & | s, |
bool | centerp = true , |
||
bool | longfirst = false |
||
) |
Reset the location from a string. See GeoCoords(const std::string& s, bool centerp, bool longfirst).
[in] | s | 1-element, 2-element, or 3-element string representation of the position. |
[in] | centerp | governs the interpretation of MGRS coordinates. |
[in] | longfirst | governs the interpretation of geographic coordinates. |
GeographicErr | if the s is malformed. |
Definition at line 19 of file src/GeoCoords.cpp.
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 260 of file GeoCoords.hpp.
|
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 zone cannot be used for this location. |
Definition at line 238 of file GeoCoords.hpp.
|
inline |
Definition at line 303 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 337 of file GeoCoords.hpp.
string GeographicLib::GeoCoords::UTMUPSRepresentation | ( | bool | northp, |
int | prec = 0 , |
||
bool | abbrev = true |
||
) | const |
UTM/UPS string with hemisphere override.
[in] | northp | hemisphere override |
[in] | prec | precision (relative to about 1m) |
[in] | abbrev | if true (the default) use abbreviated (n/s) notation for hemisphere; otherwise spell out the hemisphere (north/south) |
GeographicErr | if the hemisphere override attempts to change UPS N to UPS S or vice versa. |
std::bad_alloc | if memory for the string can't be allocated. |
Definition at line 135 of file src/GeoCoords.cpp.
string GeographicLib::GeoCoords::UTMUPSRepresentation | ( | int | prec = 0 , |
bool | abbrev = true |
||
) | const |
UTM/UPS string.
[in] | prec | precision (relative to about 1m) |
[in] | abbrev | if true (the default) use abbreviated (n/s) notation for hemisphere; otherwise spell out the hemisphere (north/south) |
std::bad_alloc | if memory for the string can't be allocated. |
Precision specifies accuracy of representation as follows:
Definition at line 129 of file src/GeoCoords.cpp.
|
staticprivate |
Definition at line 106 of file src/GeoCoords.cpp.
|
inline |
Definition at line 318 of file GeoCoords.hpp.
|
mutableprivate |
Definition at line 55 of file GeoCoords.hpp.
|
private |
Definition at line 55 of file GeoCoords.hpp.
|
private |
Definition at line 55 of file GeoCoords.hpp.
|
private |
Definition at line 55 of file GeoCoords.hpp.
|
mutableprivate |
Definition at line 56 of file GeoCoords.hpp.
|
private |
Definition at line 52 of file GeoCoords.hpp.
|
private |
Definition at line 52 of file GeoCoords.hpp.
|
private |
Definition at line 52 of file GeoCoords.hpp.
|
private |
Definition at line 52 of file GeoCoords.hpp.
|
private |
Definition at line 52 of file GeoCoords.hpp.
|
private |
Definition at line 52 of file GeoCoords.hpp.
|
private |
Definition at line 53 of file GeoCoords.hpp.
|
private |
Definition at line 54 of file GeoCoords.hpp.