OrbitalElements.TryComputePeriod Method |
Tries to calculate the period of the orbit.
Namespace:
AGI.Foundation.Coordinates
Assembly:
AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 25.1.421.0 (25.1.421.0)
Syntaxpublic static bool TryComputePeriod(
double inverseSemimajorAxis,
double gravitationalParameter,
out double period
)
Public Shared Function TryComputePeriod (
inverseSemimajorAxis As Double,
gravitationalParameter As Double,
<OutAttribute> ByRef period As Double
) As Boolean
public:
static bool TryComputePeriod(
double inverseSemimajorAxis,
double gravitationalParameter,
[OutAttribute] double% period
)
static member TryComputePeriod :
inverseSemimajorAxis : float *
gravitationalParameter : float *
period : float byref -> bool
Parameters
- inverseSemimajorAxis
- Type: System.Double
The inverse of the semimajor axis (distance). - gravitationalParameter
- Type: System.Double
The gravitational parameter (distance cubed per time squared). - period
- Type: System.Double
On return,
the period of the orbit.
Return Value
Type:
Booleanfalse if
gravitationalParameter is negative or zero; otherwise
true.
RemarksinverseSemimajorAxis and gravitationalParameter must have consistent units
and the units of the resulting period will correspond with the units of the input parameters.
See Also