EMANE  1.2.1
Public Member Functions | List of all members
EMANE::Orientation Class Reference

Holds pitch, yaw and roll. More...

#include <orientation.h>

Public Member Functions

 Orientation ()
 
 Orientation (double dRollDegrees, double dPitchDegrees, double dYawDegrees)
 
double getRollDegrees () const
 
double getPitchDegrees () const
 
double getYawDegrees () const
 
double getRollRadians () const
 
double getPitchRadians () const
 
double getYawRadians () const
 
bool operator== (const Orientation &rhs) const
 

Detailed Description

Holds pitch, yaw and roll.

Note
Instances are immutable

Definition at line 45 of file orientation.h.

Constructor & Destructor Documentation

◆ Orientation() [1/2]

EMANE::Orientation::Orientation ( )
inline

Creates an Orientation instance with pitch, yaw and roll of 0.

Definition at line 36 of file orientation.inl.

◆ Orientation() [2/2]

EMANE::Orientation::Orientation ( double  dRollDegrees,
double  dPitchDegrees,
double  dYawDegrees 
)
inline

Creates an Orientation instance

Parameters
dRollDegreesRoll in degrees
dPitchDegreesPitch in degrees
dYawDegreesYaw in degrees

Definition at line 45 of file orientation.inl.

Member Function Documentation

◆ getPitchDegrees()

double EMANE::Orientation::getPitchDegrees ( ) const
inline

Gets pitch in degrees

Returns
pitch

Definition at line 62 of file orientation.inl.

◆ getPitchRadians()

double EMANE::Orientation::getPitchRadians ( ) const
inline

Gets pitch in radians

Returns
roll

Definition at line 80 of file orientation.inl.

◆ getRollDegrees()

double EMANE::Orientation::getRollDegrees ( ) const
inline

Gets roll in degrees

Returns
roll

Definition at line 56 of file orientation.inl.

◆ getRollRadians()

double EMANE::Orientation::getRollRadians ( ) const
inline

Gets roll in radians

Returns
roll

Definition at line 74 of file orientation.inl.

◆ getYawDegrees()

double EMANE::Orientation::getYawDegrees ( ) const
inline

Gets yaw in degrees

Returns
yaw

Definition at line 68 of file orientation.inl.

◆ getYawRadians()

double EMANE::Orientation::getYawRadians ( ) const
inline

Gets yaw in radians

Returns
yaw

Definition at line 86 of file orientation.inl.

◆ operator==()

bool EMANE::Orientation::operator== ( const Orientation &  rhs) const
inline

Determines if another instance is equal

Returns
true if equal, false if not

Definition at line 92 of file orientation.inl.

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