GeographicLib::Constants Class Reference

Constants needed by GeographicLib More...

#include <GeographicLib/Constants.hpp>

List of all members.

Static Public Member Functions

static Math::real degree ()
static Math::real arcminute ()
static Math::real arcsecond ()
Ellipsoid parameters



template<typename T >
static T WGS84_a ()
static Math::real WGS84_a ()
template<typename T >
static T WGS84_f ()
static Math::real WGS84_f ()
template<typename T >
static T WGS84_GM ()
static Math::real WGS84_GM ()
template<typename T >
static T WGS84_omega ()
static Math::real WGS84_omega ()
template<typename T >
static T GRS80_a ()
static Math::real GRS80_a ()
template<typename T >
static T GRS80_GM ()
static Math::real GRS80_GM ()
template<typename T >
static T GRS80_omega ()
static Math::real GRS80_omega ()
template<typename T >
static T GRS80_J2 ()
static Math::real GRS80_J2 ()
template<typename T >
static T UTM_k0 ()
static Math::real UTM_k0 ()
template<typename T >
static T UPS_k0 ()
static Math::real UPS_k0 ()
SI units



template<typename T >
static T meter ()
static Math::real meter ()
static Math::real kilometer ()
static Math::real nauticalmile ()
template<typename T >
static T square_meter ()
static Math::real square_meter ()
static Math::real hectare ()
static Math::real square_kilometer ()
static Math::real square_nauticalmile ()
Anachronistic British units



static Math::real foot ()
static Math::real yard ()
static Math::real fathom ()
static Math::real chain ()
static Math::real furlong ()
static Math::real mile ()
static Math::real acre ()
static Math::real square_mile ()
Anachronistic US units



static Math::real surveyfoot ()

Related Functions

(Note that these are not member functions.)



 GEOGRAPHICLIB_VERSION_NUM(a, b, c)
 GEOGRAPHICLIB_VERSION
 GEOGRAPHICLIB_STATIC_ASSERT(cond, reason)

Detailed Description

Constants needed by GeographicLib

Define constants specifying the WGS84 ellipsoid, the UTM and UPS projections, and various unit conversions.

Example of use:

// Example of using the GeographicLib::Constants class

#include <iostream>
#include <exception>
#include <GeographicLib/Constants.hpp>

using namespace std;
using namespace GeographicLib;

int main() {
  try {
    cout << "WGS84 parameters:\n"
         << "a = " << Constants::WGS84_a() << " m\n"
         << "f = 1/" << 1/Constants::WGS84_f() << "\n";
  }
  catch (const exception& e) {
    cerr << "Caught exception: " << e.what() << "\n";
    return 1;
  }
  return 0;
}

Definition at line 95 of file Constants.hpp.


Member Function Documentation

static Math::real GeographicLib::Constants::degree (  )  [inline, static]

A synonym for Math::degree<real>().

Definition at line 104 of file Constants.hpp.

References GeographicLib::Math::degree().

static Math::real GeographicLib::Constants::arcminute (  )  [inline, static]
Returns:
the number of radians in an arcminute.

Definition at line 108 of file Constants.hpp.

References GeographicLib::Math::degree().

static Math::real GeographicLib::Constants::arcsecond (  )  [inline, static]
Returns:
the number of radians in an arcsecond.

Definition at line 113 of file Constants.hpp.

References GeographicLib::Math::degree().

template<typename T >
static T GeographicLib::Constants::WGS84_a (  )  [inline, static]
static Math::real GeographicLib::Constants::WGS84_a (  )  [inline, static]

A synonym for WGS84_a<real>().

Definition at line 128 of file Constants.hpp.

template<typename T >
static T GeographicLib::Constants::WGS84_f (  )  [inline, static]
static Math::real GeographicLib::Constants::WGS84_f (  )  [inline, static]

A synonym for WGS84_f<real>().

Definition at line 138 of file Constants.hpp.

template<typename T >
static T GeographicLib::Constants::WGS84_GM (  )  [inline, static]
Template Parameters:
T the type of the returned value.
Returns:
the gravitational constant of the WGS84 ellipsoid, GM, in m3 s2.

Definition at line 144 of file Constants.hpp.

Referenced by GeographicLib::NormalGravity::WGS84().

static Math::real GeographicLib::Constants::WGS84_GM (  )  [inline, static]

A synonym for WGS84_GM<real>().

Definition at line 149 of file Constants.hpp.

template<typename T >
static T GeographicLib::Constants::WGS84_omega (  )  [inline, static]
Template Parameters:
T the type of the returned value.
Returns:
the angular velocity of the WGS84 ellipsoid, , in rad s1.

Definition at line 155 of file Constants.hpp.

Referenced by GeographicLib::NormalGravity::WGS84().

static Math::real GeographicLib::Constants::WGS84_omega (  )  [inline, static]

A synonym for WGS84_omega<real>().

Definition at line 160 of file Constants.hpp.

template<typename T >
static T GeographicLib::Constants::GRS80_a (  )  [inline, static]
Template Parameters:
T the type of the returned value.
Returns:
the equatorial radius of GRS80 ellipsoid, a, in m.

Definition at line 178 of file Constants.hpp.

Referenced by GeographicLib::NormalGravity::GRS80().

static Math::real GeographicLib::Constants::GRS80_a (  )  [inline, static]

A synonym for GRS80_a<real>().

Definition at line 183 of file Constants.hpp.

template<typename T >
static T GeographicLib::Constants::GRS80_GM (  )  [inline, static]
Template Parameters:
T the type of the returned value.
Returns:
the gravitational constant of the GRS80 ellipsoid, GM, in m3 s2.

Definition at line 189 of file Constants.hpp.

Referenced by GeographicLib::NormalGravity::GRS80().

static Math::real GeographicLib::Constants::GRS80_GM (  )  [inline, static]

A synonym for GRS80_GM<real>().

Definition at line 194 of file Constants.hpp.

template<typename T >
static T GeographicLib::Constants::GRS80_omega (  )  [inline, static]
Template Parameters:
T the type of the returned value.
Returns:
the angular velocity of the GRS80 ellipsoid, , in rad s1.

This is about 2 366.25 / (365.25 24 3600) rad s1. 365.25 is the number of days in a Julian year and 365.35/366.25 converts from solar days to sidereal days. Using the number of days in a Gregorian year (365.2425) results in a worse approximation (because the Gregorian year includes the precession of the earth's axis).

Definition at line 207 of file Constants.hpp.

Referenced by GeographicLib::NormalGravity::GRS80().

static Math::real GeographicLib::Constants::GRS80_omega (  )  [inline, static]

A synonym for GRS80_omega<real>().

Definition at line 212 of file Constants.hpp.

template<typename T >
static T GeographicLib::Constants::GRS80_J2 (  )  [inline, static]
Template Parameters:
T the type of the returned value.
Returns:
the dynamical form factor of the GRS80 ellipsoid, J2.

Definition at line 218 of file Constants.hpp.

Referenced by GeographicLib::NormalGravity::GRS80().

static Math::real GeographicLib::Constants::GRS80_J2 (  )  [inline, static]

A synonym for GRS80_J2<real>().

Definition at line 223 of file Constants.hpp.

template<typename T >
static T GeographicLib::Constants::UTM_k0 (  )  [inline, static]
Template Parameters:
T the type of the returned value.
Returns:
the central scale factor for UTM (0.9996).

Definition at line 228 of file Constants.hpp.

Referenced by GeographicLib::TransverseMercatorExact::UTM(), and GeographicLib::TransverseMercator::UTM().

static Math::real GeographicLib::Constants::UTM_k0 (  )  [inline, static]

A synonym for UTM_k0<real>().

Definition at line 233 of file Constants.hpp.

template<typename T >
static T GeographicLib::Constants::UPS_k0 (  )  [inline, static]
Template Parameters:
T the type of the returned value.
Returns:
the central scale factor for UPS (0.994).

Definition at line 238 of file Constants.hpp.

Referenced by GeographicLib::PolarStereographic::UPS().

static Math::real GeographicLib::Constants::UPS_k0 (  )  [inline, static]

A synonym for UPS_k0<real>().

Definition at line 243 of file Constants.hpp.

template<typename T >
static T GeographicLib::Constants::meter (  )  [inline, static]
Template Parameters:
T the type of the returned value.
Returns:
the number of meters in a meter.

This is unity, but this lets the internal system of units be changed if necessary.

Definition at line 256 of file Constants.hpp.

static Math::real GeographicLib::Constants::meter (  )  [inline, static]

A synonym for meter<real>().

Definition at line 260 of file Constants.hpp.

static Math::real GeographicLib::Constants::kilometer (  )  [inline, static]
Returns:
the number of meters in a kilometer.

Definition at line 264 of file Constants.hpp.

static Math::real GeographicLib::Constants::nauticalmile (  )  [inline, static]
Returns:
the number of meters in a nautical mile (approximately 1 arc minute)

Definition at line 270 of file Constants.hpp.

template<typename T >
static T GeographicLib::Constants::square_meter (  )  [inline, static]
Template Parameters:
T the type of the returned value.
Returns:
the number of square meters in a square meter.

This is unity, but this lets the internal system of units be changed if necessary.

Definition at line 280 of file Constants.hpp.

static Math::real GeographicLib::Constants::square_meter (  )  [inline, static]

A synonym for square_meter<real>().

Definition at line 285 of file Constants.hpp.

static Math::real GeographicLib::Constants::hectare (  )  [inline, static]
Returns:
the number of square meters in a hectare.

Definition at line 290 of file Constants.hpp.

static Math::real GeographicLib::Constants::square_kilometer (  )  [inline, static]
Returns:
the number of square meters in a square kilometer.

Definition at line 295 of file Constants.hpp.

static Math::real GeographicLib::Constants::square_nauticalmile (  )  [inline, static]
Returns:
the number of square meters in a square nautical mile.

Definition at line 300 of file Constants.hpp.

static Math::real GeographicLib::Constants::foot (  )  [inline, static]
Returns:
the number of meters in an international foot.

Definition at line 310 of file Constants.hpp.

static Math::real GeographicLib::Constants::yard (  )  [inline, static]
Returns:
the number of meters in a yard.

Definition at line 315 of file Constants.hpp.

static Math::real GeographicLib::Constants::fathom (  )  [inline, static]
Returns:
the number of meters in a fathom.

Definition at line 319 of file Constants.hpp.

static Math::real GeographicLib::Constants::chain (  )  [inline, static]
Returns:
the number of meters in a chain.

Definition at line 323 of file Constants.hpp.

static Math::real GeographicLib::Constants::furlong (  )  [inline, static]
Returns:
the number of meters in a furlong.

Definition at line 327 of file Constants.hpp.

static Math::real GeographicLib::Constants::mile (  )  [inline, static]
Returns:
the number of meters in a statute mile.

Definition at line 331 of file Constants.hpp.

static Math::real GeographicLib::Constants::acre (  )  [inline, static]
Returns:
the number of square meters in an acre.

Definition at line 335 of file Constants.hpp.

static Math::real GeographicLib::Constants::square_mile (  )  [inline, static]
Returns:
the number of square meters in a square statute mile.

Definition at line 339 of file Constants.hpp.

static Math::real GeographicLib::Constants::surveyfoot (  )  [inline, static]
Returns:
the number of meters in a US survey foot.

Definition at line 348 of file Constants.hpp.


Friends And Related Function Documentation

GEOGRAPHICLIB_VERSION_NUM ( a,
b,
 )  [related]

Pack the version components into a single integer.

Definition at line 19 of file Constants.hpp.

GEOGRAPHICLIB_VERSION [related]

The version of GeographicLib as a single integer, packed as MMmmmmpp where MM is the major version, mmmm is the minor version, and pp is the patch level.

Definition at line 27 of file Constants.hpp.

GEOGRAPHICLIB_STATIC_ASSERT ( cond,
reason   )  [related]

A compile-time assert. Use C++11 static_assert, if available.

Definition at line 55 of file Constants.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 6 Oct 2014 for GeographicLib by  doxygen 1.6.1