Struct Orbit 

pub struct Orbit<S, T: TimeScale, O: Origin, R: ReferenceFrame> { /* private fields */ }

An orbital state parameterized by state representation, time scale, origin, and reference frame.

Implementations

impl<T, O, R> Orbit<Cartesian, T, O, R>

where T: TimeScale, O: Origin, R: ReferenceFrame,

pub const fn new( cartesian: Cartesian, time: Time<T>, origin: O, frame: R, ) -> Self

Constructs a new Cartesian orbit from position/velocity state, epoch, origin, and frame.

pub fn position(&self) -> DVec3

Returns the position vector in meters.

pub fn velocity(&self) -> DVec3

Returns the velocity vector in meters per second.

pub fn to_keplerian(&self) -> KeplerianOrbit<T, O, R>

where T: Copy, O: Copy + PointMass, R: Copy,

Converts this Cartesian orbit to Keplerian elements.

pub fn try_to_keplerian( &self, ) -> Result<KeplerianOrbit<T, O, R>, UndefinedOriginPropertyError>

where T: Copy, O: Copy + TryPointMass, R: Copy,

Converts this Cartesian orbit to Keplerian elements, returning an error if the gravitational parameter is undefined.

pub fn try_to_frame<R1, P>( &self, frame: R1, provider: &P, ) -> Result<CartesianOrbit<T, O, R1>, P::Error>

where R: Copy, P: TryRotation<R, R1, T>, R1: ReferenceFrame + Copy, O: Copy, T: Copy,

Transforms this orbit into a different reference frame using the given rotation provider.

impl<T, O> Orbit<Cartesian, T, O, Iau<O>>

where T: TimeScale, O: Origin + RotationalElements + Spheroid + Copy,

pub fn to_ground_location( &self, ) -> Result<GroundLocation<O>, FromBodyFixedError>

Converts this body-fixed Cartesian orbit to a ground location.

impl<T, O> Orbit<Cartesian, T, O, Icrf>

where T: TimeScale, O: Origin,

pub fn rotation_lvlh(&self) -> DMat3

Returns the rotation matrix from ICRF to the Local Vertical Local Horizontal (LVLH) frame.

impl<T, O> Orbit<Cartesian, T, O, Icrf>

where T: TimeScale + Copy, O: Origin + Copy,

pub fn to_origin<O1: Origin + Copy, E: Ephemeris>( &self, target: O1, ephemeris: &E, ) -> Result<CartesianOrbit<T, O1, Icrf>, E::Error>

where DefaultOffsetProvider: Offset<T, Tdb>,

Transforms this orbit to a different central body origin using an ephemeris.

impl Orbit<Cartesian, DynTimeScale, DynOrigin, DynFrame>

pub fn try_to_origin<E: Ephemeris>( &self, target: DynOrigin, ephemeris: &E, ) -> Result<DynCartesianOrbit, E::Error>

Transforms this dynamic orbit to a different central body origin using an ephemeris.

pub fn try_to_ground_location( &self, ) -> Result<DynGroundLocation, StateToDynGroundError>

Converts this dynamic Cartesian orbit to a ground location.

pub fn try_rotation_lvlh(&self) -> Result<DMat3, &'static str>

Returns the LVLH rotation matrix, returning an error if the frame is not ICRF.

impl<T, O, R> Orbit<Keplerian, T, O, R>

where T: TimeScale, O: Origin, R: ReferenceFrame,

pub const fn new( keplerian: Keplerian, time: Time<T>, origin: O, frame: R, ) -> Self

where R: QuasiInertial,

Constructs a new Keplerian orbit in a quasi-inertial frame.

pub fn try_from_keplerian( keplerian: Keplerian, time: Time<T>, origin: O, frame: R, ) -> Result<Self, KeplerianOrbitError>

where R: TryQuasiInertial, O: TryMeanRadius,

Constructs a Keplerian orbit with validation of the frame and perigee radius.

pub fn semi_major_axis(&self) -> Distance

Returns the semi-major axis.

pub fn eccentricity(&self) -> Eccentricity

Returns the eccentricity.

pub fn inclination(&self) -> Inclination

Returns the inclination.

pub fn longitude_of_ascending_node(&self) -> LongitudeOfAscendingNode

Returns the longitude of the ascending node.

pub fn argument_of_periapsis(&self) -> ArgumentOfPeriapsis

Returns the argument of periapsis.

pub fn true_anomaly(&self) -> TrueAnomaly

Returns the true anomaly.

pub fn to_cartesian(&self) -> CartesianOrbit<T, O, R>

where T: Copy, O: Copy + PointMass, R: Copy,

Converts this Keplerian orbit to Cartesian position and velocity.

pub fn try_to_cartesian( &self, ) -> Result<CartesianOrbit<T, O, R>, UndefinedOriginPropertyError>

where T: Copy, O: Copy + TryPointMass, R: Copy,

Converts this Keplerian orbit to Cartesian, returning an error if the gravitational parameter is undefined.

pub fn orbital_period(&self) -> Option<TimeDelta>

where O: TryPointMass,

Returns the orbital period, or None for non-elliptical orbits or undefined gravitational parameters.

pub fn trace(&self, n: usize) -> Option<Trajectory<T, O, R>>

where T: Copy, O: TryPointMass + Copy, R: Copy,

Generates a trajectory by tracing the full orbit with n evenly-spaced samples.

impl<S, T, O, R> Orbit<S, T, O, R>

where T: TimeScale, O: Origin, R: ReferenceFrame,

pub const fn from_state(state: S, time: Time<T>, origin: O, frame: R) -> Self

Constructs an orbit from its state, epoch, origin, and reference frame.

pub fn state(&self) -> S

where S: Copy,

Returns the orbital state.

pub fn time(&self) -> Time<T>

where T: Copy,

Returns the epoch of this orbit.

pub fn origin(&self) -> O

where O: Copy,

Returns the central body origin.

pub fn reference_frame(&self) -> R

where R: Copy,

Returns the reference frame.

pub fn try_gravitational_parameter( &self, ) -> Result<GravitationalParameter, UndefinedOriginPropertyError>

where O: TryPointMass,

Returns the gravitational parameter of the origin, or an error if undefined.

pub fn gravitational_parameter(&self) -> GravitationalParameter

where O: PointMass,

Returns the gravitational parameter of the origin.

impl<S, T, O, R> Orbit<S, T, O, R>

where T: TimeScale + Copy + Into<DynTimeScale>, O: Origin + Copy + Into<DynOrigin>, R: ReferenceFrame + Copy + Into<DynFrame>,

pub fn into_dyn(self) -> Orbit<S, DynTimeScale, DynOrigin, DynFrame>

Converts this orbit into a dynamically-typed orbit.

Trait Implementations

impl<S: Clone, T: Clone + TimeScale, O: Clone + Origin, R: Clone + ReferenceFrame> Clone for Orbit<S, T, O, R>

fn clone(&self) -> Orbit<S, T, O, R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug, T: Debug + TimeScale, O: Debug + Origin, R: Debug + ReferenceFrame> Debug for Orbit<S, T, O, R>

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

Formats the value using the given formatter.

impl<T, O, R> From<Orbit<Cartesian, T, O, R>> for CartesianState

where T: TimeScale, O: Origin, R: ReferenceFrame,

fn from(orbit: CartesianOrbit<T, O, R>) -> Self

Converts to this type from the input type.

impl<T, O, R> FromIterator<Orbit<Cartesian, T, O, R>> for Trajectory<T, O, R>

where T: TimeScale + Copy, O: Origin + Copy, R: ReferenceFrame + Copy,

fn from_iter<U: IntoIterator<Item = CartesianOrbit<T, O, R>>>(iter: U) -> Self

Creates a value from an iterator.

impl<S: PartialEq, T: PartialEq + TimeScale, O: PartialEq + Origin, R: PartialEq + ReferenceFrame> PartialEq for Orbit<S, T, O, R>

fn eq(&self, other: &Orbit<S, T, O, R>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S: Copy, T: Copy + TimeScale, O: Copy + Origin, R: Copy + ReferenceFrame> Copy for Orbit<S, T, O, R>

impl<S, T: TimeScale, O: Origin, R: ReferenceFrame> StructuralPartialEq for Orbit<S, T, O, R>