Skip to content

Class astrea::trace::Sensor

ClassList > astrea > trace > Sensor

Sensor class representing a sensor on a platform.More...

  • #include <Sensor.hpp>

Inherits the following classes: astrea::trace::AccessObject, astro::Payload< Sensor, SensorParameters >

Inherited by the following classes: astrea::trace::Antenna

Public Attributes

Type Name
const SensorParameters & parameters

Public Functions

Type Name
const SensorParameters Payload (parent, parameters)
bool contains (const astro::RadiusVector< astro::frames::earth::icrf > & sensor2target, const astro::Date & date) const
Check if the sensor can see a target given the boresight vector.
virtual std::size_t get_id () const
Get the ID of the sensor.
requires (std::is_base_of_v< astro::FrameReference, Parent_T >) const
Constructs a Sensor from aFieldOfView object.
virtual ~Sensor () = default
Default destructor for Sensor .

Public Functions inherited from astrea::trace::AccessObject

See astrea::trace::AccessObject

Type Name
void add_access (const std::size_t & receiverId, const RiseSetArray & access)
Adds access times for a specific receiver.
void drop_access (const std::size_t & receiverId, const RiseSetArray & access)
Drops access times for a specific receiver.
AccessArray & get_accesses ()
Gets the access times for this object.
const AccessArray & get_accesses () const
Gets the access times for this object (const version).
virtual std::size_t get_id () const = 0
Pure virtual function to get the ID of the object.

Protected Functions inherited from astrea::trace::AccessObject

See astrea::trace::AccessObject

Type Name
AccessObject () = default
Default constructor.
virtual ~AccessObject () = default
Default destructor.

Detailed Description

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

Public Attributes Documentation

variable parameters

const SensorParameters& astrea::trace::Sensor::parameters;

Public Functions Documentation

function Payload

inline const SensorParameters astrea::trace::Sensor::Payload (
    parent,
    parameters
)

function contains

Check if the sensor can see a target given the boresight vector. 

bool astrea::trace::Sensor::contains (
    const astro::RadiusVector< astro::frames::earth::icrf > & sensor2target,
    const astro::Date & date
) const

Parameters:

  • sensor2target Vector from the sensor to the target.
  • date The date for which the visibility is checked.

Returns:

true If the target is within the sensor's field of view.

Returns:

false If the target is outside the sensor's field of view.

function get_id

Get the ID of the sensor. 

inline virtual std::size_t astrea::trace::Sensor::get_id () const

Returns:

std::size_t ID of the sensor.

Implements astrea::trace::AccessObject::get_id

function requires

Constructs a Sensor from aFieldOfView object. 

template<typename Parent_T>
astrea::trace::Sensor::requires (
    std::is_base_of_v< astro::FrameReference, Parent_T >
) const

Parameters:

  • parent The parent platform to which the sensor is attached.
  • fov Field of view object defining the sensor's coverage area.
  • boresight The boresight vector of the sensor.
  • attachmentPoint The point on the platform where the sensor is attached.

function ~Sensor

Default destructor for Sensor . 

virtual astrea::trace::Sensor::~Sensor () = default

The documentation for this class was generated from the following file astrea/trace/trace/platforms/sensors/Sensor.hpp