Skip to content

Class astrea::astro::NullEvent

ClassList > astrea > astro > NullEvent

A class representing a null Event in the astrea astro platform. This class is used as a placeholder for Events that do not have a defined state or mass.

  • #include <NullEvent.hpp>

Public Functions

Type Name
std::string get_name () const
Gets the name of the Event .
bool is_terminal () const
Checks if the Event is a terminalEvent .
Unitless measure_event (const Time & time, const State & state, const Vehicle & vehicle) const
Detects if the Event is triggered by aVehicle .

Public Functions Documentation

function get_name

Gets the name of the Event . 

inline std::string astrea::astro::NullEvent::get_name () const

Returns:

std::string The name of the Event.

function is_terminal

Checks if the Event is a terminalEvent . 

inline bool astrea::astro::NullEvent::is_terminal () const

Returns:

true If the Event is a terminal Event.

Returns:

false If the Event is not a terminal Event.

function measure_event

Detects if the Event is triggered by aVehicle . 

inline Unitless astrea::astro::NullEvent::measure_event (
    const Time & time,
    const State & state,
    const Vehicle & vehicle
) const

Parameters:

Returns:

true If the Event is triggered by the Vehicle.

Returns:

false If the Event is not triggered by the Vehicle.

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