Geodetic coordinates with longitude, latitude, and altitude. More...

#include <GeoCoordinates3d.h>

Collaboration diagram for olp::geo::GeoCoordinates3d:

Public Member Functions
	GeoCoordinates3d ()
	Creates a `GeoCoordinates3d` instance with invalid geodetic coordinates. More...

	GeoCoordinates3d (double latitude_radians, double longitude_radians, double altitude_meters)
	Creates a `GeoCoordinates3d` instance from latitude, longitude, and altitude. More...

	GeoCoordinates3d (double latitude_degrees, double longitude_degrees, double altitude_meters, DegreeType degrees)
	Creates a `GeoCoordinates3d` instance from latitude, longitude, and altitude. More...

	GeoCoordinates3d (const GeoCoordinates &geo_coordinates)
	Creates a `GeoCoordinates3d` instance from 2D coordinates with undefined altitude. More...

	GeoCoordinates3d (const GeoCoordinates &geo_coordinates, double altitude_meters)
	Creates a `GeoCoordinates3d` instance from 2D coordinates and altitude. More...

const GeoCoordinates &	GetGeoCoordinates () const
	Gets the latitude and longitude as 2D geodetic coordinates. More...

void	SetGeoCoordinates (const GeoCoordinates &geo_coordinates)
	Sets the latitude and longitude from the 2D geodetic coordinates. More...

double	GetLatitude () const
	Gets the latitude in radians. More...

void	SetLatitude (double latitude_radians)
	Sets the latitude in radians. More...

double	GetLongitude () const
	Gets the longitude in radians. More...

void	SetLongitude (double longitude_radians)
	Sets the longitude in radians. More...

double	GetLatitudeDegrees () const
	Gets the latitude in degrees. More...

void	setLatitudeDegrees (double latitude_degrees)
	Sets the latitude in degrees. More...

double	GetLongitudeDegrees () const
	Gets the longitude in degrees. More...

void	SetLongitudeDegrees (double longitude_degrees)
	Sets the longitude in degrees. More...

double	GetAltitude () const
	Gets the altitude in meters. More...

void	SetAltitude (double altitude_meters)
	Sets the altitude in meters. More...

	operator bool () const
	Checks whether the coordinates and altitude are valid. More...

bool	IsValid () const
	Checks whether the coordinates and altitude are valid. More...

Static Public Member Functions
static GeoCoordinates3d	FromDegrees (double latitude, double longitude, double altitude=0.0)
	Creates a `GeoCoordinates3d` instance from latitude, longitude, and altitude. More...

static GeoCoordinates3d	FromRadians (double latitude, double longitude, double altitude=0.0)
	Creates a `GeoCoordinates3d` instance from latitude, longitude, and altitude. More...

Protected Attributes
GeoCoordinates	geo_coordinates_
	The 2D geodetic coordinates.

double	altitude_
	The altitude in meters.

Static Protected Attributes
static const double	kNaN_
	The const that signalizes invalid altitudes.

Detailed Description

Geodetic coordinates with longitude, latitude, and altitude.

Constructor & Destructor Documentation

◆ GeoCoordinates3d() [1/5]

olp::geo::GeoCoordinates3d::GeoCoordinates3d ( )

Creates a GeoCoordinates3d instance with invalid geodetic coordinates.

Postcondition: The latitude, longitude, and altitude are undefined (NaN).

◆ GeoCoordinates3d() [2/5]

olp::geo::GeoCoordinates3d::GeoCoordinates3d	(	double	latitude_radians,
		double	longitude_radians,
		double	altitude_meters
	)

Creates a GeoCoordinates3d instance from latitude, longitude, and altitude.

Parameters

[in]	latitude_radians	The latitude in radians.
[in]	longitude_radians	The longitude in radians.
[in]	altitude_meters	The altitude in meters.

◆ GeoCoordinates3d() [3/5]

olp::geo::GeoCoordinates3d::GeoCoordinates3d	(	double	latitude_degrees,
		double	longitude_degrees,
		double	altitude_meters,
		DegreeType	degrees
	)

Creates a GeoCoordinates3d instance from latitude, longitude, and altitude.

Parameters

latitude_degrees	The latitude in degrees.
longitude_degrees	The longitude in degrees.
altitude_meters	The altitude in meters.
degrees	The degree tag.

◆ GeoCoordinates3d() [4/5]

olp::geo::GeoCoordinates3d::GeoCoordinates3d ( const GeoCoordinates & geo_coordinates )

explicit

Creates a GeoCoordinates3d instance from 2D coordinates with undefined altitude.

Parameters

[in] geo_coordinates The 2D geodetic coordinates.

Postcondition: The altitude is undefined (NaN).

◆ GeoCoordinates3d() [5/5]

olp::geo::GeoCoordinates3d::GeoCoordinates3d	(	const GeoCoordinates &	geo_coordinates,
		double	altitude_meters
	)

Creates a GeoCoordinates3d instance from 2D coordinates and altitude.

Parameters

[in]	geo_coordinates	The 2D geodetic coordinates.
[in]	altitude_meters	The altitude in meters.

Member Function Documentation

◆ FromDegrees()

static GeoCoordinates3d olp::geo::GeoCoordinates3d::FromDegrees	(	double	latitude,
		double	longitude,
		double	altitude = `0.0`
	)

static

Creates a GeoCoordinates3d instance from latitude, longitude, and altitude.

Parameters

[in]	latitude	The latitude in degrees.
[in]	longitude	The longitude in degrees.
[in]	altitude	The altitude in meters.

Returns: The GeoCoordinates3d instance.

◆ FromRadians()

static GeoCoordinates3d olp::geo::GeoCoordinates3d::FromRadians	(	double	latitude,
		double	longitude,
		double	altitude = `0.0`
	)

static

Creates a GeoCoordinates3d instance from latitude, longitude, and altitude.

Parameters

[in]	latitude	The latitude in radians.
[in]	longitude	The longitude in radians.
[in]	altitude	The altitude in meters.

Returns: The GeoCoordinates3d instance.

◆ GetAltitude()

double olp::geo::GeoCoordinates3d::GetAltitude ( ) const

Gets the altitude in meters.

Returns: The altitude in meters.

◆ GetGeoCoordinates()

const GeoCoordinates& olp::geo::GeoCoordinates3d::GetGeoCoordinates ( ) const

Gets the latitude and longitude as 2D geodetic coordinates.

Returns: The 2D geodetic coordinates.

◆ GetLatitude()

double olp::geo::GeoCoordinates3d::GetLatitude ( ) const

Gets the latitude in radians.

Returns: The latitude in radians.

◆ GetLatitudeDegrees()

double olp::geo::GeoCoordinates3d::GetLatitudeDegrees ( ) const

Gets the latitude in degrees.

Returns: The latitude in degrees.

◆ GetLongitude()

double olp::geo::GeoCoordinates3d::GetLongitude ( ) const

Gets the longitude in radians.

Returns: The longitude in radians.

◆ GetLongitudeDegrees()

double olp::geo::GeoCoordinates3d::GetLongitudeDegrees ( ) const

Gets the longitude in degrees.

Returns: The longitude in degrees.

◆ IsValid()

bool olp::geo::GeoCoordinates3d::IsValid ( ) const

Checks whether the coordinates and altitude are valid.

Returns: True if the coordinates and altitude are valid; false if the latitude, longitude, or altitude is undefined.

◆ operator bool()

olp::geo::GeoCoordinates3d::operator bool ( ) const

explicit

Checks whether the coordinates and altitude are valid.

Returns: True if the coordinates and altitude are valid; false if the latitude, longitude, or altitude is undefined.

◆ SetAltitude()

void olp::geo::GeoCoordinates3d::SetAltitude ( double altitude_meters )

Sets the altitude in meters.

Parameters

[in] altitude_meters The altitude in meters.

◆ SetGeoCoordinates()

void olp::geo::GeoCoordinates3d::SetGeoCoordinates ( const GeoCoordinates & geo_coordinates )

Sets the latitude and longitude from the 2D geodetic coordinates.

Parameters

[in] geo_coordinates The 2D geodetic coordinates.

◆ SetLatitude()

void olp::geo::GeoCoordinates3d::SetLatitude ( double latitude_radians )

Sets the latitude in radians.

Parameters

[in] latitude_radians The latitude in radians.

◆ setLatitudeDegrees()

void olp::geo::GeoCoordinates3d::setLatitudeDegrees ( double latitude_degrees )

Sets the latitude in degrees.

Parameters

[in] latitude_degrees The latitude in degrees.

◆ SetLongitude()

void olp::geo::GeoCoordinates3d::SetLongitude ( double longitude_radians )

Sets the longitude in radians.

Parameters

[in] longitude_radians The longitude in radians.

◆ SetLongitudeDegrees()

void olp::geo::GeoCoordinates3d::SetLongitudeDegrees ( double longitude_degrees )

Sets the longitude in degrees.

Parameters

[in] longitude_degrees The longitude in degrees.

The documentation for this class was generated from the following file:

olp-cpp-sdk-core/include/olp/core/geo/coordinates/GeoCoordinates3d.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GeoCoordinates3d() [1/5]

◆ GeoCoordinates3d() [2/5]

◆ GeoCoordinates3d() [3/5]

◆ GeoCoordinates3d() [4/5]

◆ GeoCoordinates3d() [5/5]

Member Function Documentation

◆ FromDegrees()

◆ FromRadians()

◆ GetAltitude()

◆ GetGeoCoordinates()

◆ GetLatitude()

◆ GetLatitudeDegrees()

◆ GetLongitude()

◆ GetLongitudeDegrees()

◆ IsValid()

◆ operator bool()

◆ SetAltitude()

◆ SetGeoCoordinates()

◆ SetLatitude()

◆ setLatitudeDegrees()

◆ SetLongitude()

◆ SetLongitudeDegrees()