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

Orientation. More...

#include <Orientation.hpp>

Public Member Functions

 Orientation () noexcept=default
 Default Constructor. More...
 
 Orientation (const Orientation &other) noexcept=default
 Copy Constructor. More...
 
constexpr Orientation (double inRoll, double inPitch, double inYaw) noexcept
 Constructor. More...
 
 Orientation (Orientation &&other) noexcept=default
 Move Orientation. More...
 
virtual ~Orientation ()=default
 Destructor. More...
 
bool operator!= (const Orientation &other) const noexcept
 Non-Equality Operator. More...
 
Orientationoperator= (const Orientation &other) noexcept=default
 Copy Assignement Operator. More...
 
Orientationoperator= (Orientation &&other) noexcept=default
 Move Assignement Operator. More...
 
bool operator== (const Orientation &other) const noexcept
 Non-Equality Operator. More...
 

Data Fields

double pitch { 0. }
 
double roll { 0. }
 
double yaw { 0. }
 

Detailed Description

Constructor & Destructor Documentation

◆ Orientation() [1/4]

nc::coordinates::Orientation::Orientation ( )
defaultnoexcept

Default Constructor.

◆ Orientation() [2/4]

constexpr nc::coordinates::Orientation::Orientation ( double  inRoll,
double  inPitch,
double  inYaw 
)
inlineconstexprnoexcept

Constructor.

Parameters
inRollthe roll component
inPitchthe pitch component
inYawthe yaw component

◆ Orientation() [3/4]

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

Copy Constructor.

Parameters
otherthe other Orientation instance

◆ Orientation() [4/4]

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

Move Orientation.

Parameters
otherthe other Orientation instance

◆ ~Orientation()

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

Destructor.

Member Function Documentation

◆ operator!=()

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

Non-Equality Operator.

Parameters
otherother object
Returns
bool true if not equal equal

◆ operator=() [1/2]

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

Copy Assignement Operator.

Parameters
otherthe other Orientation instance

◆ operator=() [2/2]

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

Move Assignement Operator.

Parameters
otherthe other Orientation instance

◆ operator==()

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

Non-Equality Operator.

Parameters
otherother object
Returns
bool true if not equal equal

Field Documentation

◆ pitch

double nc::coordinates::Orientation::pitch { 0. }

◆ roll

double nc::coordinates::Orientation::roll { 0. }

◆ yaw

double nc::coordinates::Orientation::yaw { 0. }

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