Class astrea::astro::Payload¶

template <class Payload_T, class PayloadParameters_T>

ClassList > astrea > astro > Payload

Payload class representing a payload on a platform.More...

#include <Payload.hpp>

Public Functions¶

Type	Name
std::size_t	generate_id () const Generate a hash for the payload ID.
virtual std::size_t	get_id () const = 0 Get the ID of the payload.
PayloadParameters_T	get_parameters () const Get the payload parameters of the payload.
const PayloadPlatform< Payload_T > *const	get_parent () const Get the parent platform of the payload.

Protected Attributes¶

Type	Name
std::size_t	_id Unique identifier for the payload.
PayloadParameters_T	_parameters Payload parameters.
const PayloadPlatform< Payload_T > *	_parent Parent platform.
const PayloadParameters_T &	parameters

Protected Functions¶

Type	Name
const PayloadParameters_T	_id (generate_id())
const PayloadParameters_T	_parameters (parameters)
	requires (std::is_base_of_v< PayloadPlatform< Payload_T >, Parent_T >) const Constructs a Payload from a FieldOfView object.
	requires (std::is_base_of_v< PayloadPlatform< Payload_T >, Parent_T >) const Set the parent platform of the payload.
virtual	~Payload () = default Default destructor for Payload .

Detailed Description¶

This class inherits from AccessObject and provides functionality for payloads, including field of view and access management.

Public Functions Documentation¶

function generate_id¶

Generate a hash for the payload ID.

inline std::size_t astrea::astro::Payload::generate_id () const

function get_id¶

Get the ID of the payload.

virtual std::size_t astrea::astro::Payload::get_id () const = 0

Returns:

std::size_t ID of the payload.

function get_parameters¶

Get the payload parameters of the payload.

inline PayloadParameters_T astrea::astro::Payload::get_parameters () const

Returns:

PayloadParameters_T Payload parameters of the payload.

function get_parent¶

Get the parent platform of the payload.

inline const PayloadPlatform < Payload_T > *const astrea::astro::Payload::get_parent () const

Returns:

const PayloadPlatform<Payload_T, PayloadParameters_T>* Pointer to the parent platform.

Protected Attributes Documentation¶

variable _id [1/2]¶

Unique identifier for the payload.

std::size_t astrea::astro::Payload< Payload_T, PayloadParameters_T >::_id;

variable _parameters [1/2]¶

Payload parameters.

PayloadParameters_T astrea::astro::Payload< Payload_T, PayloadParameters_T >::_parameters;

variable _parent¶

Parent platform.

const PayloadPlatform<Payload_T>* astrea::astro::Payload< Payload_T, PayloadParameters_T >::_parent;

variable parameters¶

const PayloadParameters_T& astrea::astro::Payload< Payload_T, PayloadParameters_T >::parameters;

Protected Functions Documentation¶

function _id [2/2]¶

inline const PayloadParameters_T astrea::astro::Payload::_id (
    generate_id ()
)

function _parameters [2/2]¶

const PayloadParameters_T astrea::astro::Payload::_parameters (
    parameters
)

function requires [1/2]¶

Constructs a Payload from a FieldOfView object.

template<typename Parent_T>
astrea::astro::Payload::requires (
    std::is_base_of_v< PayloadPlatform < Payload_T >, Parent_T >
) const

Parameters:

parent The parent platform to which the payload is attached.
parameters The parameters for the payload.

function requires [2/2]¶

Set the parent platform of the payload.

template<typename Parent_T>
inline astrea::astro::Payload::requires (
    std::is_base_of_v< PayloadPlatform < Payload_T >, Parent_T >
) const

Template parameters:

T Type of the parent platform.

Parameters:

parent The parent platform to set.

function ~Payload¶

Default destructor for Payload .

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

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