NumCpp  2.12.1
A Templatized Header Only C++ Implementation of the Python NumPy Library
nc::coordinates::Cartesian Class Reference

Cartensian coordinates. More...

#include <Cartesian.hpp>

Inherited by nc::coordinates::reference_frames::ECEF, nc::coordinates::reference_frames::ENU, and nc::coordinates::reference_frames::NED.

Public Member Functions

 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...
 
virtual ~Cartesian ()=default
 Destructor. More...
 
bool operator!= (const Cartesian &other) const noexcept
 Non-Equality Operator. More...
 
Cartesianoperator= (Cartesian &&other) noexcept=default
 Move Assignement Operator. More...
 
Cartesianoperator= (const Cartesian &other) noexcept=default
 Copy Assignement Operator. More...
 
bool operator== (const Cartesian &other) const noexcept
 Non-Equality Operator. 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

Cartensian coordinates.

Constructor & Destructor Documentation

◆ Cartesian() [1/7]

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

Default Constructor.

◆ Cartesian() [2/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

◆ Cartesian() [3/7]

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

Default Constructor.

Parameters
inCartesianVector

◆ Cartesian() [4/7]

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

Default Constructor.

Parameters
inCartesianVector

◆ Cartesian() [5/7]

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

Constructor

Parameters
inCartesianVector

◆ Cartesian() [6/7]

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

Copy Constructor.

Parameters
otherthe other Cartesian instance

◆ Cartesian() [7/7]

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

Move Constructor.

Parameters
otherthe other Cartesian instance

◆ ~Cartesian()

virtual nc::coordinates::Cartesian::~Cartesian ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator!=()

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

Non-Equality Operator.

Parameters
otherother object
Returns
bool true if not equal equal

◆ operator=() [1/2]

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

Move Assignement Operator.

Parameters
otherthe other Cartesian instance

◆ operator=() [2/2]

Cartesian & nc::coordinates::Cartesian::operator= ( const Cartesian other)
defaultnoexcept

Copy Assignement Operator.

Parameters
otherthe other Cartesian instance

◆ operator==()

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

Non-Equality Operator.

Parameters
otherother object
Returns
bool true if not equal equal

◆ xHat()

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

x Unit Vector

Returns
unit vector in x direction

◆ yHat()

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

y Unit Vector

Returns
unit vector in y direction

◆ zHat()

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

z Unit Vector

Returns
unit vector in z direction

Field Documentation

◆ x

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

◆ y

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

◆ z

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

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