DotNet.Astronomy.Class.BodyOrbit

EliteDangerousAlmanac / Astronomy / BodyOrbit

Class: BodyOrbit

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/BodyOrbit.cs:54

Where one orbit takes a body, and how the body turns along it.

Remarks

Every calculation reads the figures the scan states, and answers null where the body states none it can use.

The maths is ported from the Canonn Research Group's canonn-signals. See ATTRIBUTIONS.md for credit and licence terms.

Methods

ClassifyEccentricity()

static ClassifyEccentricity(eccentricity): EccentricityClass

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/BodyOrbit.cs:85

How far from a circle one orbit is.

Parameters

eccentricity

double

The eccentricity, from zero upwards.

Returns

EccentricityClass

The class the eccentricity falls in.

Exceptions

ArgumentOutOfRangeException

The eccentricity is not a finite figure of zero or more.

EquatorialVelocity()

static EquatorialVelocity(body): double?

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/BodyOrbit.cs:147

How fast a body's equator travels as it turns, in metres a second.

Parameters

body

BodyProperties

The body, as a scan states it.

Returns

double?

The speed, or null where the body states no radius, or a rotation period of zero.

Exceptions

ArgumentNullException

The body is absent.

Extents()

static Extents(body): OrbitExtents?

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/BodyOrbit.cs:66

How near and how far one orbit takes a body.

Parameters

body

BodyProperties

The body, as a scan states it.

Returns

OrbitExtents?

The extents, or null where the body states no semi-major axis.

Remarks

A body that states no eccentricity is read as travelling a circle.

Exceptions

ArgumentNullException

The body is absent.

Resonance()

static Resonance(body): SpinOrbitResonance?

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/BodyOrbit.cs:111

Whether a body's turning and its orbit keep step.

Parameters

body

BodyProperties

The body, as a scan states it.

Returns

SpinOrbitResonance?

The simplest whole-number ratio within a hundredth, or null where the body states no usable period or the two keep no such step.

Remarks

Both periods are read without their signs, because a body that turns the other way keeps step just the same. Neither term goes above five.

Exceptions

ArgumentNullException

The body is absent.