LifetimeElements

java.lang.Object
- agi.foundation.coordinates.LifetimeElements

All Implemented Interfaces:

ICloneWithContext
```
public final class LifetimeElements
extends Object
implements ICloneWithContext
```
A set of elements produced by the LifetimeOrbitPropagator to represent the approximate mean classical elements associated with the periapsis of each successive orbit over the course of a satellite's lifetime.

Constructor Summary

Constructors
Constructor and Description
`LifetimeElements(JulianDate epoch, int orbitCount, double semimajorAxis, double semimajorAxisRate, double eccentricity, double eccentricityRate, double inclination, double inclinationRate, double argumentOfPeriapsis, double argumentOfPeriapsisRate, double rightAscensionOfAscendingNode, double rightAscensionOfAscendingNodeRate, double siderealPeriod, double gravitationalParameter)` Initialize a set of lifetime orbit elements to represent one orbit pass.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone(CopyContext context)` Clones this object using the specified context.
`double`	`getArgumentOfPeriapsis()` Gets the argument of periapsis of the orbit, in radians.
`double`	`getArgumentOfPeriapsisRate()` Gets the current rate of change of the `ArgumentOfPeriapsis` (`get`), in radians per second.
`double`	`getEccentricity()` Gets the eccentricity of the orbit.
`double`	`getEccentricityRate()` Gets the current rate of change of the `Eccentricity` (`get`), in units per second.
`double`	`getGravitationalParameter()` Gets the gravitational parameter used for this element set (distance cubed per time squared).
`double`	`getInclination()` Gets the inclination of the orbit, in radians.
`double`	`getInclinationRate()` Gets the current rate of change of the `Inclination` (`get`), in radians per second.
`int`	`getOrbitCount()` Gets the number of orbits produced by the propagator from the initial conditions to the current elements.
`double`	`getRightAscensionOfAscendingNode()` Gets the right ascension of the ascending node of the orbit, in radians.
`double`	`getRightAscensionOfAscendingNodeRate()` Gets the current rate of change of the `RightAscensionOfAscendingNode` (`get`), in radians per second.
`double`	`getSemimajorAxis()` Gets the semimajor axis of the orbit, in meters.
`double`	`getSemimajorAxisRate()` Gets the current rate of change of the `SemimajorAxis` (`get`), in meters per second.
`double`	`getSiderealPeriod()` Gets the approximate orbit period, in seconds, for the current orbit pass.
`JulianDate`	`getTimeOfPeriapsis()` Gets the time at the periapsis of this orbit pass.
`KeplerianElements`	`toKeplerianMeanElements()` Convert these elements to an equivalent `KeplerianElements` representation at the periapsis.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LifetimeElements
```
public LifetimeElements(@Nonnull
                        JulianDate epoch,
                        int orbitCount,
                        double semimajorAxis,
                        double semimajorAxisRate,
                        double eccentricity,
                        double eccentricityRate,
                        double inclination,
                        double inclinationRate,
                        double argumentOfPeriapsis,
                        double argumentOfPeriapsisRate,
                        double rightAscensionOfAscendingNode,
                        double rightAscensionOfAscendingNodeRate,
                        double siderealPeriod,
                        double gravitationalParameter)
```
    Initialize a set of lifetime orbit elements to represent one orbit pass.
    The classification of the OrbitType is exact so that if the user wants this instance of KeplerianElements to be classified as a Circular orbit, the eccentricity must be exactly zero. For parabolic or hyperbolic orbits, see ModifiedKeplerianElements.
    
    Parameters:
    
    epoch - The time at periapsis.
    
    orbitCount - The number of orbits, including this one, since the reference epoch.
    
    semimajorAxis - Semimajor axis, in meters.
    
    semimajorAxisRate - The rate of change of the semimajor axis, in meters per second.
    
    eccentricity - Eccentricity.
    
    eccentricityRate - The rate of change of the eccentricity, in units per second.
    
    inclination - Inclination, in radians.
    
    inclinationRate - The rate of change of the inclination, in radians per second.
    
    argumentOfPeriapsis - Argument of periapsis, in radians.
    
    argumentOfPeriapsisRate - The rate of change of the argument of periapsis, in radians per second.
    
    rightAscensionOfAscendingNode - Right ascension of the ascending node, in radians.
    
    rightAscensionOfAscendingNodeRate - The rate of change of the right ascension of the ascending node, in radians per second.
    
    siderealPeriod - The time required to make one full orbit with respect to inertial space, in seconds.
    
    gravitationalParameter - Gravitational parameter (meters cubed per second squared).
    
    Throws:
    
    ArgumentOutOfRangeException - The given elements must represent a closed orbit. The exception is thrown if the eccentricity is negative, not below unity, or if the semimajor axis is not finitely positive. For other orbit types, use ModifiedKeplerianElements.
    
    ArgumentOutOfRangeException - The semimajor axis cannot be zero or nearly zero. Thrown if semimajorAxis is < Constants.Epsilon8.
    
    ArgumentOutOfRangeException - Thrown if the inclination is less than zero or greater than Pi radians.
- Method Detail
  - clone
```
public final Object clone(CopyContext context)
```
    Clones this object using the specified context.
    
    This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.
    
    A typical implementation of ICloneWithContext:
```
public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}
```
    In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:
    1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
    2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.
    If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.
```
alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}
```
    If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:
    1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
    2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
    3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.
```
public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;
```
    Specified by:
    
    clone in interface ICloneWithContext
    
    Parameters:
    
    context - The context to use to perform the copy.
    
    Returns:
    
    A new instance which is a copy of this object.
  - getTimeOfPeriapsis
```
@Nonnull
public final JulianDate getTimeOfPeriapsis()
```
    Gets the time at the periapsis of this orbit pass.
  - getOrbitCount
```
public final int getOrbitCount()
```
    Gets the number of orbits produced by the propagator from the initial conditions to the current elements.
  - getSemimajorAxis
```
public final double getSemimajorAxis()
```
    Gets the semimajor axis of the orbit, in meters. Semimajor axis represents half the distance between the periapsis and the apoapsis.
  - getEccentricity
```
public final double getEccentricity()
```
    Gets the eccentricity of the orbit.
    
    Eccentricity e can be calculated on the basis of semimajor axis a and semiminor axis b as follows:
```
    e = sqrt(1 - (b / a)^2)
    
```
    Referring to the following diagram, e can also be expressed as a / f, where f is the distance from the center of the ellipse to the center of mass of the central body:
  - getInclination
```
public final double getInclination()
```
    Gets the inclination of the orbit, in radians.
    
    The inclination of the orbit is its tilt with reference to the Equatorial plane, or, in the diagram below, the angle i between the central body's spin (Z) axis and the orbit's angular momentum vector.
    
    In the above diagram, ω is the argument of periapsis, θ is the true anomaly, and Ω is the right ascension of the ascending node (RAAN).
  - getArgumentOfPeriapsis
```
public final double getArgumentOfPeriapsis()
```
    Gets the argument of periapsis of the orbit, in radians.
    
    The argument of periapsis, ω, is the angular distance between the ascending node and periapsis:
    
    In the above diagram, Ω is the right ascension of the ascending node (RAAN), θ is the true anomaly, and i is the inclination.
  - getRightAscensionOfAscendingNode
```
public final double getRightAscensionOfAscendingNode()
```
    Gets the right ascension of the ascending node of the orbit, in radians.
    
    The ascending node is the point where the satellite crosses the equator moving south to north. In the diagram below, this point is referenced from the +X direction, which points in the Vernal Equinox direction. The angle between the X axis and the ascending node is called the right ascension of the ascending node (RAAN), represented here by Ω.
    
    In the above diagram, ω is the argument of periapsis, θ is the true anomaly, and i is the inclination.
  - getGravitationalParameter
```
public final double getGravitationalParameter()
```
    Gets the gravitational parameter used for this element set (distance cubed per time squared).
  - getSiderealPeriod
```
public final double getSiderealPeriod()
```
    Gets the approximate orbit period, in seconds, for the current orbit pass.
  - getEccentricityRate
```
public final double getEccentricityRate()
```
    Gets the current rate of change of the Eccentricity (get), in units per second.
  - getSemimajorAxisRate
```
public final double getSemimajorAxisRate()
```
    Gets the current rate of change of the SemimajorAxis (get), in meters per second.
  - getInclinationRate
```
public final double getInclinationRate()
```
    Gets the current rate of change of the Inclination (get), in radians per second.
  - getArgumentOfPeriapsisRate
```
public final double getArgumentOfPeriapsisRate()
```
    Gets the current rate of change of the ArgumentOfPeriapsis (get), in radians per second.
  - getRightAscensionOfAscendingNodeRate
```
public final double getRightAscensionOfAscendingNodeRate()
```
    Gets the current rate of change of the RightAscensionOfAscendingNode (get), in radians per second.
  - toKeplerianMeanElements
```
public final KeplerianElements toKeplerianMeanElements()
```
    Convert these elements to an equivalent KeplerianElements representation at the periapsis.
    
    Returns:
    
    The approximate mean orbital elements of the current orbit pass.

Class LifetimeElements

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LifetimeElements

Method Detail

clone

getTimeOfPeriapsis

getOrbitCount

getSemimajorAxis

getEccentricity

getInclination

getArgumentOfPeriapsis

getRightAscensionOfAscendingNode

getGravitationalParameter

getSiderealPeriod

getEccentricityRate

getSemimajorAxisRate

getInclinationRate

getArgumentOfPeriapsisRate

getRightAscensionOfAscendingNodeRate

toKeplerianMeanElements