Class astrea::astro::NullVehicle¶

ClassList > astrea > astro > NullVehicle

A class representing a null vehicle in the astrea astro platform. This class is used as a placeholder for vehicles that do not have a defined state or mass.

#include <NullVehicle.hpp>

Inherits the following classes: astrea::astro::FrameReference

Public Functions¶

Type	Name
	NullVehicle (const Mass & mass=0.0 mp_units::unit_symbols::kg) Constructs a* NullVehicle with an initial state and mass.
NullVehicle *	clone () const Clone the NullVehicle object.
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 Get the position of the frame in Earth-Centered Inertial coordinates.
virtual CartesianVector< Velocity, frames::earth::icrf >	get_inertial_velocity (const Date & date) const Get the velocity of the frame in Earth-Centered Inertial coordinates.
Mass	get_mass () const Gets the mass of the vehicle.
virtual std::string	get_name () const Gets the name of the vehicle.

Public Functions inherited from astrea::astro::FrameReference¶

See astrea::astro::FrameReference

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 .

Public Functions Documentation¶

function NullVehicle¶

Constructs a NullVehicle with an initial state and mass.

astrea::astro::NullVehicle::NullVehicle (
    const Mass & mass=0.0 *mp_units::si::unit_symbols::kg
)

Parameters:

mass The mass of the vehicle, defaulting to zero kilograms.

function clone¶

Clone the NullVehicle object.

NullVehicle * astrea::astro::NullVehicle::clone () const

Returns:

NullVehicle* A pointer to a new NullVehicle object that is a copy of this one.

function get_inertial_acceleration¶

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

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

Parameters:

date The date for which to get the acceleration.

Returns:

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

Implements astrea::astro::FrameReference::get_inertial_acceleration

function get_inertial_position¶

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

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

Parameters:

date The date for which to get the position.

Returns:

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

Implements astrea::astro::FrameReference::get_inertial_position

function get_inertial_velocity¶

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

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

Parameters:

date The date for which to get the velocity.

Returns:

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

Implements astrea::astro::FrameReference::get_inertial_velocity

function get_mass¶

Gets the mass of the vehicle.

Mass astrea::astro::NullVehicle::get_mass () const

Returns:

Mass The mass of the vehicle.

function get_name¶

Gets the name of the vehicle.

virtual std::string astrea::astro::NullVehicle::get_name () const

Returns:

std::string The name of the vehicle.

Implements astrea::astro::FrameReference::get_name

The documentation for this class was generated from the following file astrea/astro/astro/platforms/vehicles/NullVehicle.hpp