Sgp4Elements

java.lang.Object
- agi.foundation.propagators.Sgp4Elements

All Implemented Interfaces:

ICloneWithContext

Direct Known Subclasses:

CelestrakGeneralPerturbationElements, TwoLineElementSet, UsafGeneralPerturbationElements
```
public class Sgp4Elements
extends Object
implements ICloneWithContext
```
A set of orbital elements intended to be propagated with the SGP4 propagator.

Constructor Summary

Constructors
Constructor and Description
`Sgp4Elements()` Initializes a new instance.
`Sgp4Elements(Sgp4Elements existingInstance)` Initializes a new instance as a copy of an existing instance.

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`	`getArgumentOfPerigee()` Gets the argument of perigee, in degrees.
`double`	`getBStar()` Gets the BSTAR drag term, in units of 1 / EarthRadii.
`double`	`getEccentricity()` Gets the eccentricity
`JulianDate`	`getEpoch()` Gets the epoch at which these initial conditions are defined.
`double`	`getInclination()` Gets the inclination, in degrees
`double`	`getMeanAnomaly()` Gets the mean anomaly, in degrees.
`double`	`getMeanMotion()` Gets the mean motion, in revolutions per day.
`double`	`getRawEpoch()` Gets the epoch at which these initial conditions are defined, represented in the standard form: YYDDD.DDDD.
`double`	`getRightAscensionOfAscendingNode()` Gets the right ascension of the ascending node, in degrees
`Sgp4ElementsSwitching`	`getSwitchingMethod()` Gets the method to use when switching between this element set and the following element set.
`void`	`setArgumentOfPerigee(double value)` Sets the argument of perigee, in degrees.
`void`	`setBStar(double value)` Sets the BSTAR drag term, in units of 1 / EarthRadii.
`void`	`setEccentricity(double value)` Sets the eccentricity
`void`	`setEpoch(JulianDate value)` Sets the epoch at which these initial conditions are defined.
`void`	`setInclination(double value)` Sets the inclination, in degrees
`void`	`setMeanAnomaly(double value)` Sets the mean anomaly, in degrees.
`void`	`setMeanMotion(double value)` Sets the mean motion, in revolutions per day.
`void`	`setRawEpoch(double value)` Sets the epoch at which these initial conditions are defined, represented in the standard form: YYDDD.DDDD.
`void`	`setRightAscensionOfAscendingNode(double value)` Sets the right ascension of the ascending node, in degrees
`void`	`setSwitchingMethod(Sgp4ElementsSwitching value)` Sets the method to use when switching between this element set and the following element set.

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

- Constructor Detail
  - Sgp4Elements
```
public Sgp4Elements()
```
    Initializes a new instance.
  - Sgp4Elements
```
public Sgp4Elements(@Nonnull
                    Sgp4Elements existingInstance)
```
    Initializes a new instance as a copy of an existing instance.
    
    Parameters:
    
    existingInstance - The existing instance to copy.
    
    Throws:
    
    ArgumentNullException - Thrown when existingInstance is null.
- Method Detail
  - clone
```
public 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.
  - getEpoch
```
@Nonnull
public JulianDate getEpoch()
```
    Gets the epoch at which these initial conditions are defined.
  - setEpoch
```
public void setEpoch(@Nonnull
                     JulianDate value)
```
    Sets the epoch at which these initial conditions are defined.
  - getRawEpoch
```
public double getRawEpoch()
```
    Gets the epoch at which these initial conditions are defined, represented in the standard form: YYDDD.DDDD. Note: this will be represented to as much precision as possible and will not reflect the RawEpoch (get / set) taken from a TwoLineElementSet format. To represent the correct precision for a TLE, use the TwoLineElementSet type instead.
  - setRawEpoch
```
public void setRawEpoch(double value)
```
    Sets the epoch at which these initial conditions are defined, represented in the standard form: YYDDD.DDDD. Note: this will be represented to as much precision as possible and will not reflect the RawEpoch (get / set) taken from a TwoLineElementSet format. To represent the correct precision for a TLE, use the TwoLineElementSet type instead.
  - getBStar
```
public final double getBStar()
```
    Gets the BSTAR drag term, in units of 1 / EarthRadii. This term represents a modification of the ballistic coefficient (Coefficient of drag times area over mass). The value is modified by one half atmospheric density and expressed in units of inverse Earth radii. Source: https://celestrak.com/
    Warning: This is equal to the ballistic coefficient (Coefficient of drag times area over mass) if the EphemerisType (get / set) is equal to 4.
  - setBStar
```
public final void setBStar(double value)
```
    Sets the BSTAR drag term, in units of 1 / EarthRadii. This term represents a modification of the ballistic coefficient (Coefficient of drag times area over mass). The value is modified by one half atmospheric density and expressed in units of inverse Earth radii. Source: https://celestrak.com/
    Warning: This is equal to the ballistic coefficient (Coefficient of drag times area over mass) if the EphemerisType (get / set) is equal to 4.
  - getInclination
```
public final double getInclination()
```
    Gets the inclination, in degrees
  - setInclination
```
public final void setInclination(double value)
```
    Sets the inclination, in degrees
  - getRightAscensionOfAscendingNode
```
public final double getRightAscensionOfAscendingNode()
```
    Gets the right ascension of the ascending node, in degrees
  - setRightAscensionOfAscendingNode
```
public final void setRightAscensionOfAscendingNode(double value)
```
    Sets the right ascension of the ascending node, in degrees
  - getEccentricity
```
public final double getEccentricity()
```
    Gets the eccentricity
  - setEccentricity
```
public final void setEccentricity(double value)
```
    Sets the eccentricity
  - getArgumentOfPerigee
```
public final double getArgumentOfPerigee()
```
    Gets the argument of perigee, in degrees.
  - setArgumentOfPerigee
```
public final void setArgumentOfPerigee(double value)
```
    Sets the argument of perigee, in degrees.
  - getMeanAnomaly
```
public final double getMeanAnomaly()
```
    Gets the mean anomaly, in degrees.
  - setMeanAnomaly
```
public final void setMeanAnomaly(double value)
```
    Sets the mean anomaly, in degrees.
  - getMeanMotion
```
public final double getMeanMotion()
```
    Gets the mean motion, in revolutions per day.
  - setMeanMotion
```
public final void setMeanMotion(double value)
```
    Sets the mean motion, in revolutions per day.
  - getSwitchingMethod
```
public final Sgp4ElementsSwitching getSwitchingMethod()
```
    Gets the method to use when switching between this element set and the following element set. By default, this is Sgp4ElementsSwitchByEpoch.
  - setSwitchingMethod
```
public final void setSwitchingMethod(Sgp4ElementsSwitching value)
```
    Sets the method to use when switching between this element set and the following element set. By default, this is Sgp4ElementsSwitchByEpoch.

Class Sgp4Elements

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Sgp4Elements

Method Detail

clone

getEpoch

setEpoch

getRawEpoch

setRawEpoch

getBStar

setBStar

getInclination

setInclination

getRightAscensionOfAscendingNode

setRightAscensionOfAscendingNode

getEccentricity

setEccentricity

getArgumentOfPerigee

setArgumentOfPerigee

getMeanAnomaly

setMeanAnomaly

getMeanMotion

setMeanMotion

getSwitchingMethod

setSwitchingMethod