NumCpp  2.12.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
nc::coordinates::reference_frames::ENU Class Referencefinal

East North Up coordinates. More...

#include <ENU.hpp>

Inherits nc::coordinates::Cartesian.

Public Member Functions

constexpr ENU (const Cartesian &cartesian) noexcept
 Constructor. More...
 
constexpr ENU (double east, double north, double up) noexcept
 Constructor. More...
 
 Cartesian () noexcept=default
 Default Constructor. More...
 
 Cartesian (Cartesian &&other) noexcept=default
 Move Constructor. More...
 
 Cartesian (const Cartesian &other) noexcept=default
 Copy Constructor. More...
 
 Cartesian (const NdArray< double > &inCartesianVector)
 
 Cartesian (const Vec2 &inCartesianVector)
 Default Constructor. More...
 
 Cartesian (const Vec3 &inCartesianVector)
 Default Constructor. More...
 
constexpr Cartesian (double inX, double inY, double inZ=0.) noexcept
 Constructor. More...
 
double east () const noexcept
 east getter More...
 
double north () const noexcept
 north getter More...
 
bool operator!= (const Cartesian &other) const noexcept
 Non-Equality Operator. More...
 
bool operator== (const Cartesian &other) const noexcept
 Non-Equality Operator. More...
 
void setEast (double east) noexcept
 east setter More...
 
void setNorth (double north) noexcept
 north setter More...
 
void setUp (double up) noexcept
 up setter More...
 
double up () const noexcept
 up getter More...
 

Static Public Member Functions

static Cartesian xHat () noexcept
 x Unit Vector More...
 
static Cartesian yHat () noexcept
 y Unit Vector More...
 
static Cartesian zHat () noexcept
 z Unit Vector More...
 

Data Fields

double x { 0. }
 
double y { 0. }
 
double z { 0. }
 

Detailed Description

East North Up coordinates.

Constructor & Destructor Documentation

◆ ENU() [1/2]

constexpr nc::coordinates::reference_frames::ENU::ENU ( const Cartesian cartesian)
inlineconstexprnoexcept

Constructor.

Parameters
cartesiancartesian vector

◆ ENU() [2/2]

constexpr nc::coordinates::reference_frames::ENU::ENU ( double  east,
double  north,
double  up 
)
inlineconstexprnoexcept

Constructor.

Parameters
easteast value
northnorth value
upup value

Member Function Documentation

◆ Cartesian() [1/7]

nc::coordinates::Cartesian::Cartesian ( )
defaultnoexcept

Default Constructor.

◆ Cartesian() [2/7]

nc::coordinates::Cartesian::Cartesian ( Cartesian &&  other)
defaultnoexcept

Move Constructor.

Parameters
otherthe other Cartesian instance

◆ Cartesian() [3/7]

nc::coordinates::Cartesian::Cartesian ( const Cartesian other)
defaultnoexcept

Copy Constructor.

Parameters
otherthe other Cartesian instance

◆ Cartesian() [4/7]

nc::coordinates::Cartesian::Cartesian ( const NdArray< double > &  inCartesianVector)
inline

Constructor

Parameters
inCartesianVector

◆ Cartesian() [5/7]

nc::coordinates::Cartesian::Cartesian ( const Vec2 inCartesianVector)
inline

Default Constructor.

Parameters
inCartesianVector

◆ Cartesian() [6/7]

nc::coordinates::Cartesian::Cartesian ( const Vec3 inCartesianVector)
inline

Default Constructor.

Parameters
inCartesianVector

◆ Cartesian() [7/7]

constexpr nc::coordinates::Cartesian::Cartesian ( double  inX,
double  inY,
double  inZ = 0. 
)
inlineconstexprnoexcept

Constructor.

Parameters
inXthe x component
inYthe y component
inZthe z component

◆ east()

double nc::coordinates::reference_frames::ENU::east ( ) const
inlinenoexcept

east getter

Returns
east

◆ north()

double nc::coordinates::reference_frames::ENU::north ( ) const
inlinenoexcept

north getter

Returns
double

◆ operator!=()

bool nc::coordinates::Cartesian::operator!= ( const Cartesian other) const
inlinenoexceptinherited

Non-Equality Operator.

Parameters
otherother object
Returns
bool true if not equal equal

◆ operator==()

bool nc::coordinates::Cartesian::operator== ( const Cartesian other) const
inlinenoexceptinherited

Non-Equality Operator.

Parameters
otherother object
Returns
bool true if not equal equal

◆ setEast()

void nc::coordinates::reference_frames::ENU::setEast ( double  east)
inlinenoexcept

east setter

Parameters
easteast value

◆ setNorth()

void nc::coordinates::reference_frames::ENU::setNorth ( double  north)
inlinenoexcept

north setter

Parameters
northnorth value

◆ setUp()

void nc::coordinates::reference_frames::ENU::setUp ( double  up)
inlinenoexcept

up setter

Parameters
upup value

◆ up()

double nc::coordinates::reference_frames::ENU::up ( ) const
inlinenoexcept

up getter

Returns
up

◆ xHat()

static Cartesian nc::coordinates::Cartesian::xHat ( )
inlinestaticnoexceptinherited

x Unit Vector

Returns
unit vector in x direction

◆ yHat()

static Cartesian nc::coordinates::Cartesian::yHat ( )
inlinestaticnoexceptinherited

y Unit Vector

Returns
unit vector in y direction

◆ zHat()

static Cartesian nc::coordinates::Cartesian::zHat ( )
inlinestaticnoexceptinherited

z Unit Vector

Returns
unit vector in z direction

Field Documentation

◆ x

double nc::coordinates::Cartesian::x { 0. }
inherited

◆ y

double nc::coordinates::Cartesian::y { 0. }
inherited

◆ z

double nc::coordinates::Cartesian::z { 0. }
inherited

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