Trait nyx_space::cosmic::State

source · 
pub trait State: Copy + PartialEq + Display + LowerExp + Send + Syncwhere
    Self: Sized,
    DefaultAllocator: Allocator<f64, Self::Size> + Allocator<f64, Self::Size, Self::Size> + Allocator<f64, Self::VecLength>,{
    type Size: DimName;
    type VecLength: DimName;

    fn as_vector(&self) -> Result<OVector<f64, Self::VecLength>, NyxError>;
    fn set(
        &mut self,
        epoch: Epoch,
        vector: &OVector<f64, Self::VecLength>
    ) -> Result<(), NyxError>;
    fn epoch(&self) -> Epoch;
    fn set_epoch(&mut self, epoch: Epoch);

    fn zeros() -> Self { ... }
    fn stm(&self) -> Result<OMatrix<f64, Self::Size, Self::Size>, NyxError> { ... }
    fn reset_stm(&mut self) { ... }
    fn set_with_delta_seconds(
        self,
        delta_t_s: f64,
        vector: &OVector<f64, Self::VecLength>
    ) -> Self
    where
        DefaultAllocator: Allocator<f64, Self::VecLength>,
    { ... }
    fn add(self, _other: OVector<f64, Self::Size>) -> Self { ... }
    fn value(&self, _param: &StateParameter) -> Result<f64, NyxError> { ... }
    fn set_value(
        &mut self,
        _param: &StateParameter,
        _val: f64
    ) -> Result<(), NyxError> { ... }
}
Expand description

A trait for generate propagation and estimation state. The first parameter is the size of the state, the second is the size of the propagated state including STM and extra items.

Required Associated Types

Size of the state and its STM

Required Methods

Return this state as a vector for the propagation/estimation

Set this state

Retrieve the Epoch

Set the Epoch

Provided Methods

Initialize an empty state By default, this is not implemented. This function must be implemented when filtering on this state.

Return this state as a vector for the propagation/estimation By default, this is not implemented. This function must be implemented when filtering on this state.

Return this state as a vector for the propagation/estimation By default, this is not implemented. This function must be implemented when filtering on this state.

Reconstruct a new State from the provided delta time in seconds compared to the current state and with the provided vector.

By default, this is not implemented. This function must be implemented when filtering on this state.

Return the value of the parameter, returns an error by default

Allows setting the value of the given parameter. NOTE: Most paramaters where the value is available CANNOT be also set for that parameter (it’s a much harder problem!)

Implementors

Implementation of Orbit as a State for orbital dynamics with STM