Class astrea::astro::EventDetector

ClassList > astrea > astro > EventDetector

A class for detecting events in the astrea astro platform.

• #include <EventDetector.hpp>

Public Functions

Type	Name
	EventDetector () = default Default constructor for EventDetector .
	EventDetector (const std::vector< Event > & events) Constructs an EventDetector with a given list of Events.
bool	detect_events (const Time & time, State & state, Vehicle & vehicle) Detects events for a given time and vehicle.
gtl::btree_map< std::string, std::vector< Date > >	get_event_times (const Date & epoch) const Retrieves the event times recorded during propagation.
std::vector< Event >	get_events () const Get events being tracked.
void	set_events (const std::vector< Event > & events) Sets the list of Events to track.
	~EventDetector () = default Destructor for EventDetector .

Public Functions Documentation

function EventDetector [1/2]

Default constructor for EventDetector .

astrea::astro::EventDetector::EventDetector () = default

---

function EventDetector [2/2]

Constructs an EventDetector with a given list of Events.

astrea::astro::EventDetector::EventDetector (
    const std::vector< Event > & events
) 

Parameters:

• events The list of Events to track.

---

function detect_events

Detects events for a given time and vehicle.

bool astrea::astro::EventDetector::detect_events (
    const Time & time,
    State & state,
    Vehicle & vehicle
) 

Parameters:

• time The current time.
• state The current state.
• vehicle The Vehicle to check for events.

Returns:

true If a terminal event was detected.

Returns:

false If no terminal event was detected.

---

function get_event_times

Retrieves the event times recorded during propagation.

gtl::btree_map< std::string, std::vector< Date > > astrea::astro::EventDetector::get_event_times (
    const Date & epoch
) const

Parameters:

• epoch The epoch to which the event times are relative.

Returns:

const std::vector<Date>& A vector of dates representing the event times.

---

function get_events

Get events being tracked.

std::vector< Event > astrea::astro::EventDetector::get_events () const

Returns:

const std::vector<Event>& A const reference to the list of Events being tracked.

---

function set_events

Sets the list of Events to track.

void astrea::astro::EventDetector::set_events (
    const std::vector< Event > & events
) 

Parameters:

• events The list of Events to track.

---

function ~EventDetector

Destructor for EventDetector .

astrea::astro::EventDetector::~EventDetector () = default

---

---

The documentation for this class was generated from the following file astrea/astro/astro/propagation/event_detection/EventDetector.hpp