agi.foundation.geometry

(agi.foundation.core-2024r3.jar)

Class ScalarKozaiIzsakMeanElement

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.geometry.Scalar

agi.foundation.geometry.ScalarKozaiIzsakMeanElement

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class ScalarKozaiIzsakMeanElement
extends Scalar

A Scalar that computes a given element from a DynamicKozaiIzsakMeanElements.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ScalarKozaiIzsakMeanElement() Initializes a new instance.
	ScalarKozaiIzsakMeanElement(double gravitationalParameter, Point location, KozaiIzsakMeanElement element, ReferenceFrame frame, double j2UnnormalizedValue, double referenceDistance) Initializes a new instance.
protected	ScalarKozaiIzsakMeanElement(ScalarKozaiIzsakMeanElement existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(Scalar other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(ScalarKozaiIzsakMeanElement other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
DynamicKozaiIzsakMeanElements	getDynamicElements() Gets the DynamicKozaiIzsakMeanElements to use.
KozaiIzsakMeanElement	getElement() Gets the KozaiIzsakMeanElement to compute.
ScalarEvaluator	getEvaluator(EvaluatorGroup group) Gets an evaluator that can be used to find the value of an KozaiIzsakMeanElement of a DynamicKozaiIzsakMeanElements at a given JulianDate.
ReferenceFrame	getFrame() Gets the ReferenceFrame to compute the point in.
double	getGravitationalParameter() Gets the gravitational parameter to use to compute the elements.
double	getJ2ZonalHarmonicCoefficient() Gets the non-normalized J2 zonal harmonic coefficient.
Point	getOrbitalPoint() Gets the Point to compute.
double	getReferenceDistance() Gets the reference distance (equatorial radius) associated with the J2 coefficient.
void	setDynamicElements(DynamicKozaiIzsakMeanElements value) Sets the DynamicKozaiIzsakMeanElements to use.
void	setElement(KozaiIzsakMeanElement value) Sets the KozaiIzsakMeanElement to compute.
void	setFrame(ReferenceFrame value) Sets the ReferenceFrame to compute the point in.
void	setGravitationalParameter(double value) Sets the gravitational parameter to use to compute the elements.
void	setJ2ZonalHarmonicCoefficient(double value) Sets the non-normalized J2 zonal harmonic coefficient.
void	setOrbitalPoint(Point value) Sets the Point to compute.
void	setReferenceDistance(double value) Sets the reference distance (equatorial radius) associated with the J2 coefficient.

Methods inherited from class agi.foundation.geometry.Scalar

add, add, add, add, add, checkForSameDefinition, createScalarDerivative, divide, divide, divide, divide, divide, getEvaluator, multiply, multiply, multiply, multiply, multiply, power, subtract, subtract, subtract, subtract, subtract, toScalar

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScalarKozaiIzsakMeanElement

public ScalarKozaiIzsakMeanElement()

Initializes a new instance. The user must set OrbitalPoint (get / set), Element (get / set), GravitationalParameter (get / set) and the Frame (get / set).

ScalarKozaiIzsakMeanElement

public ScalarKozaiIzsakMeanElement(double gravitationalParameter,
                                   Point location,
                                   @Nonnull
                                   KozaiIzsakMeanElement element,
                                   ReferenceFrame frame,
                                   double j2UnnormalizedValue,
                                   double referenceDistance)

Initializes a new instance.

Parameters:

gravitationalParameter - The gravitational parameter.

location - The Point whose position and velocity will be used to compute the element.

element - The specific KozaiIzsakMeanElement to compute.

frame - The ReferenceFrame to observe the location in.

j2UnnormalizedValue - The non-normalized J2 zonal harmonic coefficient.

referenceDistance - The reference distance (equatorial radius) associated with the J2 coefficient.

ScalarKozaiIzsakMeanElement

protected ScalarKozaiIzsakMeanElement(@Nonnull
                                      ScalarKozaiIzsakMeanElement existingInstance,
                                      @Nonnull
                                      CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context 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

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final boolean checkForSameDefinition(Scalar other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class Scalar

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected boolean checkForSameDefinition(ScalarKozaiIzsakMeanElement other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the ScalarKozaiIzsakMeanElement.checkForSameDefinition(agi.foundation.geometry.Scalar) method.

Overrides:

computeCurrentDefinitionHashCode in class Scalar

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class DefinitionalObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getElement

@Nonnull
public final KozaiIzsakMeanElement getElement()

Gets the KozaiIzsakMeanElement to compute.

setElement

public final void setElement(@Nonnull
                             KozaiIzsakMeanElement value)

Sets the KozaiIzsakMeanElement to compute.

getFrame

public final ReferenceFrame getFrame()

Gets the ReferenceFrame to compute the point in. This is stored in the DynamicElements (get / set).

setFrame

public final void setFrame(ReferenceFrame value)

Sets the ReferenceFrame to compute the point in. This is stored in the DynamicElements (get / set).

getOrbitalPoint

public final Point getOrbitalPoint()

Gets the Point to compute.

setOrbitalPoint

public final void setOrbitalPoint(Point value)

Sets the Point to compute.

getGravitationalParameter

public final double getGravitationalParameter()

Gets the gravitational parameter to use to compute the elements. This is stored in the DynamicElements (get / set).

setGravitationalParameter

public final void setGravitationalParameter(double value)

Sets the gravitational parameter to use to compute the elements. This is stored in the DynamicElements (get / set).

getJ2ZonalHarmonicCoefficient

public final double getJ2ZonalHarmonicCoefficient()

Gets the non-normalized J2 zonal harmonic coefficient. This is stored in the DynamicElements (get / set).

setJ2ZonalHarmonicCoefficient

public final void setJ2ZonalHarmonicCoefficient(double value)

Sets the non-normalized J2 zonal harmonic coefficient. This is stored in the DynamicElements (get / set).

getReferenceDistance

public final double getReferenceDistance()

Gets the reference distance (equatorial radius) associated with the J2 coefficient. This is stored in the DynamicElements (get / set).

setReferenceDistance

public final void setReferenceDistance(double value)

Sets the reference distance (equatorial radius) associated with the J2 coefficient. This is stored in the DynamicElements (get / set).

getDynamicElements

public final DynamicKozaiIzsakMeanElements getDynamicElements()

Gets the DynamicKozaiIzsakMeanElements to use.

setDynamicElements

public final void setDynamicElements(DynamicKozaiIzsakMeanElements value)

Sets the DynamicKozaiIzsakMeanElements to use.

getEvaluator

public ScalarEvaluator getEvaluator(EvaluatorGroup group)

Gets an evaluator that can be used to find the value of an KozaiIzsakMeanElement of a DynamicKozaiIzsakMeanElements at a given JulianDate.

Specified by:

getEvaluator in class Scalar

Parameters:

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

An evaluator for this scalar.

Throws:

ArgumentNullException - Thrown when group is null.

PropertyInvalidException - Thrown when DynamicElements (get / set), OrbitalPoint (get / set), Frame (get / set), or ReferenceDistance (get / set) is null, or when GravitationalParameter (get / set) is not greater than zero.