Struct astrea::astro::Frame

template <CelestialBodyId origin, FrameAxis axis>

ClassList > astrea > astro > Frame

Base class for all state/frames.

• #include <Frame.hpp>

Public Static Functions

Type	Name
constexpr FrameAxis	get_axis () Get the origin of the frame.
constexpr CelestialBodyId	get_origin () Get the origin of the frame.

Protected Static Attributes

Type	Name
constexpr FrameAxis	_axis = axis The axis type of the inertial frame.
constexpr CelestialBodyId	_origin = origin The central body associated with the inertial frame.

Protected Functions

Type	Name
virtual	~Frame () = default Default destructor for Frame .

Public Static Functions Documentation

function get_axis

Get the origin of the frame.

static inline constexpr FrameAxis astrea::astro::Frame::get_axis () 

Returns:

The origin of the frame.

---

function get_origin

Get the origin of the frame.

static inline constexpr CelestialBodyId astrea::astro::Frame::get_origin () 

Returns:

The origin of the frame.

---

Protected Static Attributes Documentation

variable _axis

The axis type of the inertial frame.

constexpr FrameAxis astrea::astro::Frame< origin, axis >::_axis;

---

variable _origin

The central body associated with the inertial frame.

constexpr CelestialBodyId astrea::astro::Frame< origin, axis >::_origin;

---

Protected Functions Documentation

function ~Frame

Default destructor for Frame .

virtual astrea::astro::Frame::~Frame () = default

---

---

The documentation for this class was generated from the following file astrea/astro/astro/frames/Frame.hpp