OrbitalElementsTryComputeEccentricity Method |
Tries to calculate the eccentricity of the orbit.
Namespace:
AGI.Foundation.Coordinates
Assembly:
AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax public static bool TryComputeEccentricity(
double radiusOfPeriapsis,
double inverseSemimajorAxis,
out double eccentricity
)
Public Shared Function TryComputeEccentricity (
radiusOfPeriapsis As Double,
inverseSemimajorAxis As Double,
<OutAttribute> ByRef eccentricity As Double
) As Boolean
public:
static bool TryComputeEccentricity(
double radiusOfPeriapsis,
double inverseSemimajorAxis,
[OutAttribute] double% eccentricity
)
static member TryComputeEccentricity :
radiusOfPeriapsis : float *
inverseSemimajorAxis : float *
eccentricity : float byref -> bool
Parameters
- radiusOfPeriapsis
- Type: SystemDouble
The radius of periapsis. - inverseSemimajorAxis
- Type: SystemDouble
The inverse of the semimajor axis. - eccentricity
- Type: SystemDouble
On return,
the eccentricity of the orbit.
Return Value
Type:
Boolean if
radiusOfPeriapsis is negative or zero; otherwise
.
Remarks radiusOfPeriapsis and inverseSemimajorAxis must have consistent units.
See Also