Struct Event

pub struct Event {
    pub parameter: StateParameter,
    pub desired_value: f64,
    pub epoch_precision: Unit,
    pub value_precision: f64,
    pub obs_frame: Option<Frame>,
}

Defines a state parameter event finder

Fields

parameter: StateParameter

The state parameter

desired_value: f64

The desired self.desired_value, must be in the same units as the state parameter

epoch_precision: Unit

The time precision after which the solver will report that it cannot find any more precise

value_precision: f64

The precision on the desired value

obs_frame: Option<Frame>

An optional frame in which to search this – it IS recommended to convert the whole trajectory instead of searching in a given frame!

Implementations

impl Event

pub fn new(parameter: StateParameter, desired_value: f64) -> Self

Match a specific event for the parameter to hit the specified value. By default, the time precision is 1 millisecond and the value precision is 1e-3 of whatever unit is the default for that parameter. For example, a radius event will seek the requested value at the meter level, and an angle event will seek it at the thousands of a degree.

pub fn within_tolerance( parameter: StateParameter, desired_value: f64, value_precision: f64, ) -> Self

Match a specific event for the parameter to hit the specified value with the provided tolerance on the value

pub fn specific( parameter: StateParameter, desired_value: f64, value_precision: f64, epoch_precision: Unit, ) -> Self

Match a specific event for the parameter to hit the specified value with the provided tolerance on the value and time

pub fn periapsis() -> Self

Match the periapasis i.e. True Anomaly == 0

pub fn apoapsis() -> Self

Match the apoapasis i.e. True Anomaly == 180

pub fn mean_surface(body: &Ellipsoid) -> Self

Match the central body’s mean equatorial radius. This is useful for detecting when an object might impact the central body.

pub fn in_frame( parameter: StateParameter, desired_value: f64, target_frame: Frame, ) -> Self

Match a specific event in another frame, using the default epoch precision and value.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Event

fn default() -> Self

Returns the “default value” for a type.

impl Display for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl EventEvaluator<Spacecraft> for Event

fn eval( &self, state: &Spacecraft, almanac: Arc<Almanac>, ) -> Result<f64, EventError>

Evaluation of the event, must return a value corresponding to whether the state is before or after the event

fn epoch_precision(&self) -> Duration

fn value_precision(&self) -> f64

fn eval_string( &self, state: &Spacecraft, _almanac: Arc<Almanac>, ) -> Result<String, EventError>

Returns a string representation of the event evaluation for the given state

fn eval_crossing( &self, prev_state: &S, next_state: &S, almanac: Arc<Almanac>, ) -> Result<bool, EventError>