Enum OrbitalElement 

pub enum OrbitalElement {
    Altitude,
    AoL,
    AoP,
    ApoapsisRadius,
    ApoapsisAltitude,
    BrouwerMeanShortSemiMajorAxis,
    BrouwerMeanShortEccentricity,
    BrouwerMeanShortInclination,
    BrouwerMeanShortRAAN,
    BrouwerMeanShortAoP,
    BrouwerMeanShortMeanAnomaly,
    C3,
    Declination,
    EccentricAnomaly,
    Eccentricity,
    EquinoctialH,
    EquinoctialK,
    EquinoctialP,
    EquinoctialQ,
    EquinoctialLambda,
    Energy,
    FlightPathAngle,
    Height,
    Latitude,
    Longitude,
    Hmag,
    HX,
    HY,
    HZ,
    HyperbolicAnomaly,
    Inclination,
    MeanAnomaly,
    PeriapsisRadius,
    PeriapsisAltitude,
    Period,
    RightAscension,
    RAAN,
    Rmag,
    SemiParameter,
    SemiMajorAxis,
    SemiMajorAxisAltitude,
    SemiMinorAxis,
    TrueAnomaly,
    TrueLongitude,
    VelocityDeclination,
    Vmag,
    X,
    Y,
    Z,
    VX,
    VY,
    VZ,
    Custom,
}

Orbital element defines all of the supported orbital elements in ANISE, which are all built from a State.

Variants

Altitude

Altitude (km)

AoL

Argument of Latitude (deg)

AoP

Argument of Periapse (deg)

ApoapsisRadius

Radius of apoapsis (km)

ApoapsisAltitude

Altitude of apoapsis (km)

BrouwerMeanShortSemiMajorAxis

Brouwer Mean Short Semi major axis (km)

BrouwerMeanShortEccentricity

Brouwer Mean Short Eccentricity

BrouwerMeanShortInclination

Brouwer Mean Short Inclination (deg)

BrouwerMeanShortRAAN

Brouwer Mean Short RAAN (deg)

BrouwerMeanShortAoP

Brouwer Mean Short Argument of Periapse (deg)

BrouwerMeanShortMeanAnomaly

Brouwer Mean Short Mean Anomaly (deg)

C3

C_3 in (km/s)^2

Declination

Declination (deg) (also called elevation if in a body fixed frame)

EccentricAnomaly

Eccentric anomaly (deg)

Eccentricity

Eccentricity (no unit)

EquinoctialH

Equinoctial H element

EquinoctialK

Equinoctial K element

EquinoctialP

Equinoctial P element

EquinoctialQ

Equinoctial Q element

EquinoctialLambda

Equinoctial mean longitude Lambda (deg)

Energy

Specific energy

FlightPathAngle

Flight path angle (deg)

Height

Geodetic height (km)

Latitude

Geodetic latitude (deg)

Longitude

Geodetic longitude (deg)

Hmag

Orbital momentum

HX

X component of the orbital momentum vector

HY

Y component of the orbital momentum vector

HZ

Z component of the orbital momentum vector

HyperbolicAnomaly

Hyperbolic anomaly (deg), only valid for hyperbolic orbits

Inclination

Inclination (deg)

MeanAnomaly

Mean anomaly (deg)

PeriapsisRadius

Radius of periapse (km)

PeriapsisAltitude

Altitude of periapse (km)

Period

Orbital period (s)

RightAscension

Right ascension (deg)

RAAN

Right ascension of the ascending node (deg)

Rmag

Norm of the radius vector

SemiParameter

Semi parameter (km)

SemiMajorAxis

Semi major axis (km)

SemiMajorAxisAltitude

Semi major axis altitude (km)

SemiMinorAxis

Semi minor axis (km)

TrueAnomaly

True anomaly

TrueLongitude

True longitude

VelocityDeclination

Velocity declination (deg)

Vmag

Norm of the velocity vector (km/s)

X

X component of the radius (km)

Y

Y component of the radius (km)

Z

Z component of the radius (km)

VX

X component of the velocity (km/s)

VY

Y component of the velocity (km/s)

VZ

Z component of the velocity (km/s)

Custom

Implementations

impl OrbitalElement

pub fn evaluate(self, orbit: CartesianState) -> Result<f64, AnalysisError>

Computes this scalar expression for the provided orbit.

pub const fn is_angle(&self) -> bool

pub const fn unit(&self) -> &'static str

impl OrbitalElement

pub fn py_evaluate(&self, orbit: CartesianState) -> Result<f64, PyErr>

Evaluate the orbital element enum variant for the provided orbit

:type orbit: Orbit :rtype: float

Trait Implementations

impl Clone for OrbitalElement

fn clone(&self) -> OrbitalElement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrbitalElement

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OrbitalElement

fn deserialize<__D>( __deserializer: __D, ) -> Result<OrbitalElement, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OrbitalElement

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

Formats the value using the given formatter.

impl<'a, 'py> FromPyObject<'a, 'py> for OrbitalElement

where OrbitalElement: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<OrbitalElement, <OrbitalElement as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for OrbitalElement

type Target = OrbitalElement

The Python output type

type Output = Bound<'py, <OrbitalElement as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<OrbitalElement as IntoPyObject<'py>>::Output, <OrbitalElement as IntoPyObject<'py>>::Error>

Performs the conversion.

impl PartialEq for OrbitalElement

fn eq(&self, other: &OrbitalElement) -> 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 PyClass for OrbitalElement

const NAME: &'static str = "OrbitalElement"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyTypeInfo for OrbitalElement

const NAME: &'static str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&'static str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for OrbitalElement

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticType for OrbitalElement

fn static_type() -> SimpleType

Return the Dhall type that represents this type.

impl Copy for OrbitalElement

impl StructuralPartialEq for OrbitalElement