Class astrea::astro::Plane¶

template <class Spacecraft_T>

ClassList > astrea > astro > Plane

A Plane is a collection ofSpacecraft that share the same orbital elements.More...

#include <Plane.hpp>

Public Types¶

Type	Name
typedef std::vector< Spacecraft_T >::const_iterator	const_iterator Const iterator for iterating over all Spacecraft in thePlane .
typedef std::vector< Spacecraft_T >::iterator	iterator Iterator for iterating over all Spacecraft in thePlane .

Public Functions¶

Type	Name
	Plane () = default Default constructor for Plane .
	Plane (std::vector< Spacecraft_T > satellites) Construct a Plane from a vector ofSpacecraft .
void	add_spacecraft (const Spacecraft_T & spacecraft) Add a Spacecraft to thePlane .
iterator	begin () Get an iterator to the beginning of the Plane .
const_iterator	begin () const Get a const iterator to the beginning of the Plane .
const_iterator	cbegin () const Get a const iterator to the beginning of the Plane .
const_iterator	cend () const Get a const iterator to the end of the Plane .
iterator	end () Get an iterator to the end of the Plane .
const_iterator	end () const Get a const iterator to the end of the Plane .
std::vector< Spacecraft_T > &	get_all_spacecraft () Get all Spacecraft in thePlane .
const std::vector< Spacecraft_T > &	get_all_spacecraft () const Get all Spacecraft in thePlane .
const std::size_t	get_id () const Get the ID of the Plane .
const Spacecraft_T &	get_spacecraft (const std::size_t & spacecraftId) const Get a Spacecraft by its ID.
void	propagate (const Time & propTime, const EquationsOfMotion & eom, Integrator & integrator) Propagate the Plane using the provided epoch and Equations of Motion.
void	propagate (const Date & endEpoch, const EquationsOfMotion & eom, Integrator & integrator) Propagate the Plane using the provided epoch and Equations of Motion.
const std::size_t	size () const Get the number of Spacecraft in thePlane .
	~Plane () Destructor for Plane .

Detailed Description¶

Template parameters:

Spacecraft_T The type of Spacecraft that this Plane will contain. Must be derived from Spacecraft.

Note:

This class is templated to allow for different types of Spacecraft, but it is expected that the type will be derived from Spacecraft.

Public Types Documentation¶

typedef const_iterator¶

Const iterator for iterating over all Spacecraft in thePlane .

using astrea::astro::Plane< Spacecraft_T >::const_iterator =  std::vector<Spacecraft_T>::const_iterator;

typedef iterator¶

Iterator for iterating over all Spacecraft in thePlane .

using astrea::astro::Plane< Spacecraft_T >::iterator =  std::vector<Spacecraft_T>::iterator;

Public Functions Documentation¶

function Plane [1/2]¶

Default constructor for Plane .

astrea::astro::Plane::Plane () = default

function Plane [2/2]¶

Construct a Plane from a vector ofSpacecraft .

astrea::astro::Plane::Plane (
    std::vector< Spacecraft_T > satellites
)

Parameters:

satellites A vector of Spacecraft to initialize the Plane.

function add_spacecraft¶

Add a Spacecraft to thePlane .

void astrea::astro::Plane::add_spacecraft (
    const Spacecraft_T & spacecraft
)

Parameters:

spacecraft The Spacecraft to add to the Plane.

function begin [1/2]¶

Get an iterator to the beginning of the Plane .

inline iterator astrea::astro::Plane::begin ()

Returns:

iterator An iterator pointing to the first Spacecraft in the Plane.

function begin [2/2]¶

Get a const iterator to the beginning of the Plane .

inline const_iterator astrea::astro::Plane::begin () const

Returns:

const_iterator A const iterator pointing to the first Spacecraft in the Plane.

function cbegin¶

Get a const iterator to the beginning of the Plane .

inline const_iterator astrea::astro::Plane::cbegin () const

Returns:

const_iterator A const iterator pointing to the first Spacecraft in the Plane.

function cend¶

Get a const iterator to the end of the Plane .

inline const_iterator astrea::astro::Plane::cend () const

Returns:

const_iterator A const iterator pointing to one past the last Spacecraft in the Plane.

function end [1/2]¶

Get an iterator to the end of the Plane .

inline iterator astrea::astro::Plane::end ()

Returns:

iterator An iterator pointing to one past the last Spacecraft in the Plane.

function end [2/2]¶

Get a const iterator to the end of the Plane .

inline const_iterator astrea::astro::Plane::end () const

Returns:

const_iterator A const iterator pointing to one past the last Spacecraft in the Plane.

function get_all_spacecraft [1/2]¶

Get all Spacecraft in thePlane .

std::vector< Spacecraft_T > & astrea::astro::Plane::get_all_spacecraft ()

Returns:

std::vector<Spacecraft_T>& A reference to the vector of Spacecraft in the Plane.

function get_all_spacecraft [2/2]¶

Get all Spacecraft in thePlane .

const std::vector< Spacecraft_T > & astrea::astro::Plane::get_all_spacecraft () const

Returns:

const std::vector<Spacecraft_T>& A const reference to the vector of Spacecraft in the Plane.

function get_id¶

Get the ID of the Plane .

inline const std::size_t astrea::astro::Plane::get_id () const

Returns:

const std::size_t The unique identifier for the Plane.

function get_spacecraft¶

Get a Spacecraft by its ID.

const Spacecraft_T & astrea::astro::Plane::get_spacecraft (
    const std::size_t & spacecraftId
) const

Parameters:

spacecraftId The ID of the Spacecraft to retrieve.

Returns:

Spacecraft_T& A reference to the Spacecraft with the specified ID.

function propagate [1/2]¶

Propagate the Plane using the provided epoch and Equations of Motion.

void astrea::astro::Plane::propagate (
    const Time & propTime,
    const EquationsOfMotion & eom,
    Integrator & integrator
)

Parameters:

propTime The total propagation time after the initial state epoch.
eom The Equations of Motion to use for propagation.
integrator The Integrator to use for propagation.

function propagate [2/2]¶

Propagate the Plane using the provided epoch and Equations of Motion.

void astrea::astro::Plane::propagate (
    const Date & endEpoch,
    const EquationsOfMotion & eom,
    Integrator & integrator
)

Parameters:

endEpoch The end epoch for propagation.
eom The Equations of Motion to use for propagation.
integrator The Integrator to use for propagation.

function size¶

Get the number of Spacecraft in thePlane .

const std::size_t astrea::astro::Plane::size () const

Returns:

std::size_t The number of Spacecraft in the Plane.

function ~Plane¶

Destructor for Plane .

inline astrea::astro::Plane::~Plane ()

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