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

North east down coordinates. More...

#include <NED.hpp>

Inherits nc::coordinates::Cartesian.

Public Member Functions

constexpr NED (const Cartesian &cartesian) noexcept
 Constructor. More...
 
constexpr NED (double north, double east, double down) 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 down () const noexcept
 down getter 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 setDown (double down) noexcept
 down setter More...
 
void setEast (double east) noexcept
 east setter More...
 
void setNorth (double north) noexcept
 north setter 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

North east down coordinates.

Constructor & Destructor Documentation

◆ NED() [1/2]

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

Constructor.

Parameters
cartesiancartesian vector

◆ NED() [2/2]

constexpr nc::coordinates::reference_frames::NED::NED ( double  north,
double  east,
double  down 
)
inlineconstexprnoexcept

Constructor.

Parameters
northnorth value
easteast value
downdown 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

◆ down()

double nc::coordinates::reference_frames::NED::down ( ) const
inlinenoexcept

down getter

Returns
down

◆ east()

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

east getter

Returns
double

◆ north()

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

north getter

Returns
north

◆ 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

◆ setDown()

void nc::coordinates::reference_frames::NED::setDown ( double  down)
inlinenoexcept

down setter

Parameters
downdown value

◆ setEast()

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

east setter

Parameters
easteast value

◆ setNorth()

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

north setter

Parameters
northnorth value

◆ 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: