Class astrea::astro::FrameReference¶

ClassList > astrea > astro > FrameReference

Base class for all frame references. More...

#include <FrameReference.hpp>

Inherited by the following classes: astrea::astro::NullVehicle, astrea::astro::PayloadPlatform, astrea::astro::Vehicle, astrea::astro::detail::VehicleInnerBase

Public Functions¶

Type	Name
	FrameReference () = default Default constructor for FrameReference .
virtual CartesianVector< Acceleration, frames::earth::icrf >	get_inertial_acceleration (const Date & date) const Get the acceleration of the frame in Earth-Centered Inertial coordinates.
virtual CartesianVector< Distance, frames::earth::icrf >	get_inertial_position (const Date & date) const = 0 Get the position of the frame in Earth-Centered Inertial coordinates.
virtual CartesianVector< Velocity, frames::earth::icrf >	get_inertial_velocity (const Date & date) const = 0 Get the velocity of the frame in Earth-Centered Inertial coordinates.
virtual std::string	get_name () const = 0 Get the name of the frame reference.
virtual	~FrameReference () = default Default destructor for FrameReference .

Detailed Description¶

This class provides a common interface for all frame references used in the astrodynamics library. It allows for easy conversion between different coordinate state/frames.

Public Functions Documentation¶

function FrameReference¶

Default constructor for FrameReference .

astrea::astro::FrameReference::FrameReference () = default

Initializes the frame reference with default values.

function get_inertial_acceleration¶

Get the acceleration of the frame in Earth-Centered Inertial coordinates.

virtual CartesianVector < Acceleration, frames::earth::icrf > astrea::astro::FrameReference::get_inertial_acceleration (
    const Date & date
) const

Parameters:

date The date for which to get the acceleration.

Returns:

CartesianVector<Acceleration, frames::earth::icrf>

function get_inertial_position¶

Get the position of the frame in Earth-Centered Inertial coordinates.

virtual CartesianVector < Distance, frames::earth::icrf > astrea::astro::FrameReference::get_inertial_position (
    const Date & date
) const = 0

Parameters:

date The date for which to get the position.

Returns:

CartesianVector<Distance, frames::earth::icrf>

function get_inertial_velocity¶

Get the velocity of the frame in Earth-Centered Inertial coordinates.

virtual CartesianVector < Velocity, frames::earth::icrf > astrea::astro::FrameReference::get_inertial_velocity (
    const Date & date
) const = 0

Parameters:

date The date for which to get the velocity.

Returns:

CartesianVector<Velocity, frames::earth::icrf>

function get_name¶

Get the name of the frame reference.

virtual std::string astrea::astro::FrameReference::get_name () const = 0

Returns:

std::string The name of the frame reference. Get the name of the frame reference.

function ~FrameReference¶

Default destructor for FrameReference .

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

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