Struct nyx_space::md::ui::Event

pub struct Event {
    pub parameter: StateParameter,
    pub desired_value: f64,
    pub epoch_precision: Unit,
    pub value_precision: f64,
    pub in_frame: Option<(Frame, Arc<Cosm>)>,
}

Expand description

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

in_frame: Option<(Frame, Arc<Cosm>)>

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

Implementations

source

impl Event

source

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.

source

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

source

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

source

pub fn periapsis() -> Self

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

source

pub fn apoapsis() -> Self

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

source

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

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

Trait Implementations

source

impl Clone for Event

source

fn clone(&self) -> Event

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Event

source

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

Formats the value using the given formatter. Read more

source

impl Default for Event

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

impl Display for Event

source

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

Formats the value using the given formatter. Read more

source

fn eval_crossing(&self, prev_state: &S, next_state: &S) -> bool

Auto Trait Implementations

impl !RefUnwindSafe for Event

impl Send for Event

impl Sync for Event

impl Unpin for Event

impl !UnwindSafe for Event

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Printing<T> for T where
T: Display,

fn to_str(self) -> String

Method to serialize generic items, slices, and slices of Vecs. Adds square brackets around Vecs (prettier lists). Implementation code is in printing.rs. Read more

fn to_plainstr(self) -> String

Method to serialize generic items, slices, and slices of Vecs. Implementation code is in printing.rs. Read more

fn rd(self) -> String

Printable in red

fn gr(self) -> String

Printable in green

fn bl(self) -> String

Printable in blue

fn yl(self) -> String

Printable in yellow

fn mg(self) -> String

Printable in magenta

fn cy(self) -> String

Printable in cyan

fn wvec(self, f: &mut File) -> Result<(), Error>

Method to write vector(s) to file f (space separated, without brackets). Passes up io errors Read more

fn pvec(self)

Method to print vector(s) to stdout (space separated,without brackets).

source

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct nyx_space::md::ui::Event

Fields

Implementations

impl Event

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

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

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

pub fn periapsis() -> Self

pub fn apoapsis() -> Self

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

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

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

impl Debug for Event

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

impl Default for Event

fn default() -> Self

impl Display for Event

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

impl EventEvaluator<BaseSpacecraft<GuidanceMode>> for Event

fn eval(&self, state: &Spacecraft) -> f64

fn epoch_precision(&self) -> Duration

fn value_precision(&self) -> f64

fn eval_crossing(&self, prev_state: &S, next_state: &S) -> bool

impl EventEvaluator<Orbit> for Event

fn epoch_precision(&self) -> Duration

fn value_precision(&self) -> f64

fn eval(&self, state: &Orbit) -> f64

fn eval_crossing(&self, prev_state: &S, next_state: &S) -> bool

Auto Trait Implementations

impl !RefUnwindSafe for Event

impl Send for Event

impl Sync for Event

impl Unpin for Event

impl !UnwindSafe for Event

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Printing<T> for T where T: Display,

fn to_str(self) -> String

fn to_plainstr(self) -> String

fn rd(self) -> String

fn gr(self) -> String

fn bl(self) -> String

fn yl(self) -> String

fn mg(self) -> String

fn cy(self) -> String

fn wvec(self, f: &mut File) -> Result<(), Error>

fn pvec(self)

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> Printing<T> for T where
T: Display,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,