FERS 1.0.0
The Flexible Extensible Radar Simulator
Loading...
Searching...
No Matches
math::RotationCoord Class Reference

Represents a rotation in terms of azimuth, elevation, and time. More...

#include "coord.h"

Public Member Functions

bool operator< (const RotationCoord &b) const noexcept
 Comparison operator based on the time component.
 
RotationCoordoperator= (const RealType a) noexcept
 Assignment operator to set azimuth, elevation, and time.
 
constexpr RotationCoord (const RealType a=0) noexcept
 Constructor to initialize azimuth, elevation, and time.
 
 RotationCoord (const RealType az, const RealType el, const RealType time) noexcept
 Constructor to initialize azimuth, elevation, and time.
 

Public Attributes

RealType azimuth {}
 Azimuth angle.
 
RealType elevation {}
 Elevation angle.
 
RealType t {}
 Time.
 

Detailed Description

Represents a rotation in terms of azimuth, elevation, and time.

Definition at line 71 of file coord.h.

Constructor & Destructor Documentation

◆ RotationCoord() [1/2]

constexpr math::RotationCoord::RotationCoord ( const RealType  a = 0)
explicitconstexprnoexcept

Constructor to initialize azimuth, elevation, and time.

Parameters
aScalar value to initialize azimuth, elevation, and time.

Definition at line 102 of file coord.h.

102: azimuth(a), elevation(a), t(a) {}
RealType t
Time.
Definition coord.h:75
RealType elevation
Elevation angle.
Definition coord.h:74
RealType azimuth
Azimuth angle.
Definition coord.h:73

◆ RotationCoord() [2/2]

math::RotationCoord::RotationCoord ( const RealType  az,
const RealType  el,
const RealType  time 
)
noexcept

Constructor to initialize azimuth, elevation, and time.

Parameters
azAzimuth angle.
elElevation angle.
timeTime component.

Definition at line 111 of file coord.h.

111 :
112 azimuth(az), elevation(el), t(time)
113 {
114 }

Member Function Documentation

◆ operator<()

bool math::RotationCoord::operator< ( const RotationCoord b) const
noexcept

Comparison operator based on the time component.

Parameters
bThe other RotationCoord to compare.
Returns
True if the current object's time is less than the other.

Definition at line 83 of file coord.h.

83{ return t < b.t; }

References t.

◆ operator=()

RotationCoord & math::RotationCoord::operator= ( const RealType  a)
noexcept

Assignment operator to set azimuth, elevation, and time.

Parameters
aScalar value to assign to all components.
Returns
Reference to the modified RotationCoord object.

Definition at line 91 of file coord.h.

92 {
93 azimuth = elevation = t = a;
94 return *this;
95 }

References azimuth, elevation, and t.

Member Data Documentation

◆ azimuth

RealType math::RotationCoord::azimuth {}

Azimuth angle.

Definition at line 73 of file coord.h.

73{}; ///< Azimuth angle

Referenced by math::from_json(), math::RotationPath::getPosition(), operator=(), and math::to_json().

◆ elevation

RealType math::RotationCoord::elevation {}

Elevation angle.

Definition at line 74 of file coord.h.

74{}; ///< Elevation angle

Referenced by math::from_json(), math::RotationPath::getPosition(), operator=(), and math::to_json().

◆ t

RealType math::RotationCoord::t {}

Time.

Definition at line 75 of file coord.h.

75{}; ///< Time

Referenced by math::from_json(), operator<(), operator=(), and math::to_json().


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