Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
sbg::Utm Class Referencefinal

#include <sbg_utm.h>

Public Member Functions

void clear ()
 
std::array< double, 2 > computeEastingNorthing (double latitude, double longitude) const
 
char getLetterDesignator () const
 
double getMeridian () const
 
int getZoneNumber () const
 
void init (double latitude, double longitude)
 
bool isInit () const
 
 Utm ()=default
 
 Utm (double latitude, double longitude)
 

Private Member Functions

double computeMeridian () const
 

Static Private Member Functions

static char computeLetterDesignator (double latitude)
 
static int computeZoneNumber (double latitude, double longitude)
 

Private Attributes

bool is_init_ = false
 
char letter_designator_ {}
 
double meridian_ {}
 
int zone_number_ {}
 

Detailed Description

Class for Utm related data

Definition at line 44 of file sbg_utm.h.

Constructor & Destructor Documentation

◆ Utm() [1/2]

sbg::Utm::Utm ( )
default

Default constructor.

◆ Utm() [2/2]

Utm::Utm ( double  latitude,
double  longitude 
)

Constructor.

Parameters
[in]latitudeLatitude in degree [-90 to +90].
[in]longitudeLongitude in degree [-180 to +180].

Definition at line 13 of file sbg_utm.cpp.

Member Function Documentation

◆ clear()

void Utm::clear ( )

Reset the instance to uninitialized UTM zone.

Definition at line 54 of file sbg_utm.cpp.

◆ computeEastingNorthing()

std::array< double, 2 > Utm::computeEastingNorthing ( double  latitude,
double  longitude 
) const

Convert latitude, longitude, to easting and northing.

Parameters
[in]latitudeLatitude, in degrees [-90 to +90].
[in]longitudeLongitude, in degrees [-180 to +180].
Returns
Array containing easting then northing in meters.

Definition at line 65 of file sbg_utm.cpp.

◆ computeLetterDesignator()

char Utm::computeLetterDesignator ( double  latitude)
staticprivate

Get UTM letter designator for the given latitude.

Parameters
[in]latitudeLatitude, in degrees.
Returns
UTM letter designator.

Definition at line 162 of file sbg_utm.cpp.

◆ computeMeridian()

double Utm::computeMeridian ( ) const
private

Compute UTM zone meridian from UTM zone number.

Returns
Meridian angle, in degrees.

Definition at line 254 of file sbg_utm.cpp.

◆ computeZoneNumber()

int Utm::computeZoneNumber ( double  latitude,
double  longitude 
)
staticprivate

Convert latitude and longitude to an UTM zone number.

Parameters
[in]latitudeLatitude, in degrees.
[in]longitudeLongitude, in degrees.
Returns
UTM zone number.

Definition at line 121 of file sbg_utm.cpp.

◆ getLetterDesignator()

char Utm::getLetterDesignator ( ) const

Returns UTM letter designator.

Returns
Letter designator.

Definition at line 37 of file sbg_utm.cpp.

◆ getMeridian()

double Utm::getMeridian ( ) const

Returns UTM meridian.

Returns
Meridian in degree.

Definition at line 32 of file sbg_utm.cpp.

◆ getZoneNumber()

int Utm::getZoneNumber ( ) const

Returns UTM zone number.

Returns
Zone number.

Definition at line 27 of file sbg_utm.cpp.

◆ init()

void Utm::init ( double  latitude,
double  longitude 
)

Initialize UTM zone.

Parameters
[in]latitudeLatitude in degree [-90 to +90].
[in]longitudeLongitude in degree [-180 to +180].

Definition at line 46 of file sbg_utm.cpp.

◆ isInit()

bool Utm::isInit ( ) const

Returns if the UTM zone has been initialized.

Returns
True if the UTM zone has been initialized.

Definition at line 22 of file sbg_utm.cpp.

Member Data Documentation

◆ is_init_

bool sbg::Utm::is_init_ = false
private

Definition at line 150 of file sbg_utm.h.

◆ letter_designator_

char sbg::Utm::letter_designator_ {}
private

Definition at line 153 of file sbg_utm.h.

◆ meridian_

double sbg::Utm::meridian_ {}
private

Definition at line 151 of file sbg_utm.h.

◆ zone_number_

int sbg::Utm::zone_number_ {}
private

Definition at line 152 of file sbg_utm.h.


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


sbg_driver
Author(s): SBG Systems
autogenerated on Fri Oct 11 2024 02:13:41