Skip to main content

Scenario

Struct Scenario 

Source
pub struct Scenario<O: Origin, R: ReferenceFrame> { /* private fields */ }
Expand description

A scenario declaring the analysis origin, reference frame, time interval, and the assets (ground stations and spacecraft) involved.

The type parameters O and R specify the “native” origin body and reference frame. For dynamic dispatch (e.g. via Python), use DynScenario.

Implementations§

Source§

impl<O: Origin + Copy + Send + Sync, R: ReferenceFrame + Copy + Send + Sync> Scenario<O, R>

Source

pub fn new( start_time: Time<Tai>, end_time: Time<Tai>, origin: O, frame: R, ) -> Self

Creates a new scenario from start/end times, origin, and frame.

Source

pub fn with_interval(interval: TimeInterval<Tai>, origin: O, frame: R) -> Self

Creates a new scenario from a time interval, origin, and frame.

Source

pub fn with_spacecraft(self, spacecraft: &[Spacecraft]) -> Self

Sets the spacecraft for this scenario.

Source

pub fn with_ground_stations(self, ground_stations: &[GroundStation]) -> Self

Sets the ground stations for this scenario.

Source

pub fn interval(&self) -> &TimeInterval<Tai>

Returns the scenario time interval.

Source

pub fn origin(&self) -> O

Returns the central body origin.

Source

pub fn frame(&self) -> R

Returns the reference frame.

Source

pub fn with_constellation( self, constellation: DynConstellation, ) -> Result<Self, ConstellationConvertError>

Add a constellation to the scenario, converting each satellite into a Spacecraft using the constellation’s selected propagator.

Source

pub fn constellations(&self) -> &[DynConstellation]

Returns the constellations in this scenario.

Source

pub fn ground_stations(&self) -> &[GroundStation]

Returns the ground stations in this scenario.

Source

pub fn spacecraft(&self) -> &[Spacecraft]

Returns the spacecraft in this scenario.

Source

pub fn propagate<P>( &self, provider: &P, ) -> Result<Ensemble<AssetId, Tai, O, R>, ScenarioPropagateError>

Propagate all spacecraft over the scenario interval, transforming trajectories to the scenario’s frame using the provided rotation provider.

Internally, each spacecraft’s OrbitSource produces a DynTrajectory which is then rotated into the concrete frame R via the mixed TryRotation<DynFrame, R, T> impls, and finally re-tagged to Trajectory<Tai, O, R>.

Source

pub fn filter_by_constellations( &self, constellations: &[ConstellationId], ) -> Self

Returns a new scenario containing only spacecraft belonging to the given constellations.

Source

pub fn filter_by_networks(&self, networks: &[NetworkId]) -> Self

Returns a new scenario containing only ground stations belonging to the given networks.

Trait Implementations§

Source§

impl<O: Clone + Origin, R: Clone + ReferenceFrame> Clone for Scenario<O, R>

Source§

fn clone(&self) -> Scenario<O, R>

Returns a duplicate 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<O: Debug + Origin, R: Debug + ReferenceFrame> Debug for Scenario<O, R>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<O, R> Freeze for Scenario<O, R>
where O: Freeze, R: Freeze,

§

impl<O, R> RefUnwindSafe for Scenario<O, R>

§

impl<O, R> Send for Scenario<O, R>
where O: Send, R: Send,

§

impl<O, R> Sync for Scenario<O, R>
where O: Sync, R: Sync,

§

impl<O, R> Unpin for Scenario<O, R>
where O: Unpin, R: Unpin,

§

impl<O, R> UnsafeUnpin for Scenario<O, R>
where O: UnsafeUnpin, R: UnsafeUnpin,

§

impl<O, R> UnwindSafe for Scenario<O, R>
where O: UnwindSafe, R: UnwindSafe,

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

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,

Source§

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.