GeographicLib
1.21
|
Convert between degrees and DMS representation. More...
#include <GeographicLib/DMS.hpp>
Public Types | |
enum | flag { NONE, LATITUDE, LONGITUDE, AZIMUTH, NUMBER } |
enum | component { DEGREE, MINUTE, SECOND } |
Static Public Member Functions | |
static Math::real | Decode (const std::string &dms, flag &ind) |
static Math::real | Decode (real d, real m=0, real s=0) throw () |
static void | DecodeLatLon (const std::string &dmsa, const std::string &dmsb, real &lat, real &lon, bool swaplatlong=false) |
static Math::real | DecodeAngle (const std::string &angstr) |
static Math::real | DecodeAzimuth (const std::string &azistr) |
static std::string | Encode (real angle, component trailing, unsigned prec, flag ind, char dmssep) |
static std::string | Encode (real angle, component trailing, unsigned prec, flag ind=NONE) |
static std::string | Encode (real angle, unsigned prec, flag ind=NONE, char dmssep=char(0)) |
static void | Encode (real ang, real &d, real &m) throw () |
static void | Encode (real ang, real &d, real &m, real &s) throw () |
Convert between degrees and DMS representation.
Parse a string representing degree, minutes, and seconds and return the angle in degrees and format an angle in degrees as degree, minutes, and seconds. In addition, handle NANs and infinities on input and output.
Example of use:
// Example of using the GeographicLib::DMS class // $Id: c12828a51e75bb4a2a28f67768acdb405f63a197 $ #include <iostream> #include <exception> #include <GeographicLib/DMS.hpp> using namespace std; using namespace GeographicLib; int main() { try { { string dms = "30d14'45.6\"S"; DMS::flag type; double ang = DMS::Decode(dms, type); cout << type << " " << ang << "\n"; } { double ang = -30.245715; string dms = DMS::Encode(ang, 6, DMS::LATITUDE); cout << dms << "\n"; } } catch (const exception& e) { cerr << "Caught exception: " << e.what() << "\n"; return 1; } return 0; }
Indicator for presence of hemisphere indicator (N/S/E/W) on latitudes and longitudes.
Math::real GeographicLib::DMS::Decode | ( | const std::string & | dms, |
flag & | ind | ||
) | [static] |
Convert a string in DMS to an angle.
[in] | dms | string input. |
[out] | ind | a DMS::flag value signaling the presence of a hemisphere indicator. |
Degrees, minutes, and seconds are indicated by the characters d, ' (single quote), " (double quote), and these components may only be given in this order. Any (but not all) components may be omitted and other symbols (e.g., the o symbol for degrees and the unicode prime and double prime symbols for minutes and seconds) may be substituted. The last component indicator may be omitted and is assumed to be the next smallest unit (thus 33d10 is interpreted as 33d10'). The final component may be a decimal fraction but the non-final components must be integers. Instead of using d, ', and " to indicate degrees, minutes, and seconds, : (colon) may be used to separate these components (numbers must appear before and after each colon); thus 50d30'10.3" may be written as 50:30:10.3, 5.5' may be written 0:5.5, and so on. The integer parts of the minutes and seconds components must be less than 60. A single leading sign is permitted. A hemisphere designator (N, E, W, S) may be added to the beginning or end of the string. The result is multiplied by the implied sign of the hemisphere designator (negative for S and W). In addition ind is set to DMS::LATITUDE if N or S is present, to DMS::LONGITUDE if E or W is present, and to DMS::NONE otherwise. Throws an error on a malformed string. No check is performed on the range of the result. Examples of legal and illegal strings are
NOTE: At present, all the string handling in the C++ implementation GeographicLib is with 8-bit characters. The support for unicode symbols for degrees, minutes, and seconds is therefore via the UTF-8 encoding. (The Javascript implementation of this class uses unicode natively, of course.)
Here is the list of Unicode symbols supported for degrees, minutes, seconds:
The codes with a leading zero byte, e.g., U+00b0, are accepted in their UTF-8 coded form 0xc2 0xb0 and as a single byte 0xb0.
Definition at line 31 of file DMS.cpp.
Referenced by main().
static Math::real GeographicLib::DMS::Decode | ( | real | d, |
real | m = 0 , |
||
real | s = 0 |
||
) | throw () [inline, static] |
Convert DMS to an angle.
[in] | d | degrees. |
[in] | m | arc minutes. |
[in] | s | arc seconds. |
This does not propagate the sign on d to the other components, so -3d20' would need to be represented as - DMS::Decode(3.0, 20.0) or DMS::Decode(-3.0, -20.0).
void GeographicLib::DMS::DecodeLatLon | ( | const std::string & | dmsa, |
const std::string & | dmsb, | ||
real & | lat, | ||
real & | lon, | ||
bool | swaplatlong = false |
||
) | [static] |
Convert a pair of strings to latitude and longitude.
[in] | dmsa | first string. |
[in] | dmsb | second string. |
[out] | lat | latitude. |
[out] | lon | longitude. |
[in] | swaplatlong | if true assume longitude is given before latitude in the absence of hemisphere designators (default false). |
By default, the lat (resp., lon) is assigned to the results of decoding dmsa (resp., dmsb). However this is overridden if either dmsa or dmsb contain a latitude or longitude hemisphere designator (N, S, E, W). Throws an error if the decoded numbers are out of the ranges [-90o, 90o] for latitude and [-180o, 360o] for longitude and, in which case lat and lon are unchanged. Finally the longitude is reduced to the range [-180o, 180o).
Definition at line 207 of file DMS.cpp.
Referenced by main().
Math::real GeographicLib::DMS::DecodeAngle | ( | const std::string & | angstr | ) | [static] |
Convert a string to an angle in degrees.
[in] | angstr | input string. |
No hemisphere designator is allowed and no check is done on the range of the result.
Definition at line 240 of file DMS.cpp.
Referenced by ReadDistance().
Math::real GeographicLib::DMS::DecodeAzimuth | ( | const std::string & | azistr | ) | [static] |
Convert a string to an azimuth in degrees.
[in] | azistr | input string. |
A hemisphere designator E/W can be used; the result is multiplied by -1 if W is present. Throws an error if the result is out of the range [-180o, 360o]. Finally the azimuth is reduced to the range [-180o, 180o).
Definition at line 249 of file DMS.cpp.
Referenced by main().
string GeographicLib::DMS::Encode | ( | real | angle, |
component | trailing, | ||
unsigned | prec, | ||
flag | ind, | ||
char | dmssep | ||
) | [static] |
Convert angle (in degrees) into a DMS string (using d, ', and ").
[in] | angle | input angle (degrees) |
[in] | trailing | DMS::component value indicating the trailing units on the string and this is given as a decimal number if necessary. |
[in] | prec | the number of digits after the decimal point for the trailing component. |
[in] | ind | DMS::flag value indicated additional formatting. |
[in] | dmssep | if non-null, use as the DMS separator character (instead of d, ', " delimiters). |
The interpretation of ind is as follows:
The integer parts of the minutes and seconds components are always given with 2 digits.
Definition at line 261 of file DMS.cpp.
Referenced by LatLonString(), AzimuthString(), DistanceStrings(), and main().
string GeographicLib::DMS::Encode | ( | real | angle, |
component | trailing, | ||
unsigned | prec, | ||
flag | ind = NONE |
||
) | [static] |
Convert angle (in degrees) into a DMS string (using d, ', and ").
[in] | angle | input angle (degrees) |
[in] | trailing | DMS::component value indicating the trailing units on the string and this is given as a decimal number if necessary. |
[in] | prec | the number of digits after the decimal point for the trailing component. |
[in] | ind | DMS::flag value indicated additional formatting. |
COMPATIBILITY NOTE: This function calls Encode(real, component, unsigned, flag, char) with a 5th argument of char(0). At some point, Encode(real, component, unsigned, flag) and will be withdrawn and the interface to Encode(real, component, unsigned, flag, char) changed so that its 4th and 5th arguments have default values. This will preserve source-level compatibility.
static std::string GeographicLib::DMS::Encode | ( | real | angle, |
unsigned | prec, | ||
flag | ind = NONE , |
||
char | dmssep = char(0) |
||
) | [inline, static] |
Convert angle into a DMS string (using d, ', and ") selecting the trailing component based on the precision.
[in] | angle | input angle (degrees) |
[in] | prec | the precision relative to 1 degree. |
[in] | ind | DMS::flag value indicated additional formatting. |
[in] | dmssep | if non-null, use as the DMS separator character (instead of d, ', " delimiters). |
prec indicates the precision relative to 1 degree, e.g., prec = 3 gives a result accurate to 0.1' and prec = 4 gives a result accurate to 1". ind is interpreted as in DMS::Encode with the additional facility that DMS::NUMBER represents angle as a number in fixed format with precision prec.
static void GeographicLib::DMS::Encode | ( | real | ang, |
real & | d, | ||
real & | m | ||
) | throw () [inline, static] |
static void GeographicLib::DMS::Encode | ( | real | ang, |
real & | d, | ||
real & | m, | ||
real & | s | ||
) | throw () [inline, static] |