Skip to content

Class astrea::astro::PayloadParameters

ClassList > astrea > astro > PayloadParameters

Class for storing and managing payload parameters.

  • #include <Payload.hpp>

Inherited by the following classes: astrea::astro::ThrusterParameters

Public Functions

Type Name
astro::RadiusVector< astro::frames::dynamic::ric > get_attachment_point () const
Get the attachment point of the payload.
astro::RadiusVector< astro::frames::dynamic::ric > get_boresight () const
Get the boresight direction of the payload.
void set_attachment_point (const astro::RadiusVector< astro::frames::dynamic::ric > & attachmentPoint)
Set the attachment point of the payload.
void set_boresight (const astro::RadiusVector< astro::frames::dynamic::ric > & boresight)
Set the boresight direction of the payload.

Protected Attributes

Type Name
astro::RadiusVector< astro::frames::dynamic::ric > _attachmentPoint
Attachment point of the payload on the platform.
astro::RadiusVector< astro::frames::dynamic::ric > _boresight
Boresight vector of the payload, indicating the direction it is pointing.

Protected Functions

Type Name
PayloadParameters (const astro::RadiusVector< astro::frames::dynamic::ric > & boresight=NADIR_RIC, const astro::RadiusVector< astro::frames::dynamic::ric > & attachmentPoint=CENTER)
Constructor for PayloadParameters .
virtual ~PayloadParameters () = default
Default destructor for PayloadParameters .

Public Functions Documentation

function get_attachment_point

Get the attachment point of the payload. 

inline astro::RadiusVector < astro::frames::dynamic::ric > astrea::astro::PayloadParameters::get_attachment_point () const

Returns:

astro::RadiusVector<astro::frames::dynamic::ric>Attachment point of the payload.

function get_boresight

Get the boresight direction of the payload. 

inline astro::RadiusVector < astro::frames::dynamic::ric > astrea::astro::PayloadParameters::get_boresight () const

Returns:

astro::RadiusVector<astro::frames::dynamic::ric>Boresight direction of the payload.

function set_attachment_point

Set the attachment point of the payload. 

inline void astrea::astro::PayloadParameters::set_attachment_point (
    const astro::RadiusVector < astro::frames::dynamic::ric > & attachmentPoint
)

Parameters:

  • attachmentPoint astro::RadiusVector<astro::frames::dynamic::ric>Attachment point of the payload.

function set_boresight

Set the boresight direction of the payload. 

inline void astrea::astro::PayloadParameters::set_boresight (
    const astro::RadiusVector < astro::frames::dynamic::ric > & boresight
)

Parameters:

  • boresight astro::RadiusVector<astro::frames::dynamic::ric>Boresight direction of the payload.

Protected Attributes Documentation

variable _attachmentPoint

Attachment point of the payload on the platform. 

astro::RadiusVector<astro::frames::dynamic::ric> astrea::astro::PayloadParameters::_attachmentPoint;

variable _boresight

Boresight vector of the payload, indicating the direction it is pointing. 

astro::RadiusVector<astro::frames::dynamic::ric> astrea::astro::PayloadParameters::_boresight;

Protected Functions Documentation

function PayloadParameters

Constructor for PayloadParameters . 

inline astrea::astro::PayloadParameters::PayloadParameters (
    const astro::RadiusVector < astro::frames::dynamic::ric > & boresight=NADIR_RIC,
    const astro::RadiusVector < astro::frames::dynamic::ric > & attachmentPoint=CENTER
)

Parameters:

  • boresight Boresight direction in RIC coordinates (default is Nadir).
  • attachmentPoint Attachment point in RIC coordinates (default is Center).

function ~PayloadParameters

Default destructor for PayloadParameters . 

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

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