agi.foundation.celestial

(agi.foundation.orbitpropagation-2024r1.jar)

Class ScalarVariableArea

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.geometry.Scalar

agi.foundation.celestial.ScalarVariableArea

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

ScalarVariableAreaArgumentLatitude, ScalarVariableAreaJulianDate

public abstract class ScalarVariableArea
extends Scalar

A Scalar that enables interpolation of spacecraft area data from .dat files to use as a reference area for AtmosphericDragForce and SimpleSolarRadiationForce.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScalarVariableArea(int interpolationOrder) Initializes a new instance.
protected	ScalarVariableArea(ScalarVariableArea 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 abstract boolean	checkForSameDefinition(ScalarVariableArea other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
int	getInterpolationOrder() Gets the order of the interpolation that will be done to estimate the area.
static ScalarVariableArea	readFrom(BufferedReader reader) Reads the variable area information in from a BufferedReader and returns a ScalarVariableArea
static ScalarVariableArea	readFrom(String fileName) Reads the variable area information in from a file (most likely a .dat) and returns a ScalarVariableArea.
void	setInterpolationOrder(int value) Sets the order of the interpolation that will be done to estimate the area.

Methods inherited from class agi.foundation.geometry.Scalar

add, add, add, add, add, checkForSameDefinition, createScalarDerivative, divide, divide, divide, divide, divide, getEvaluator, 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, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, 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

ScalarVariableArea

protected ScalarVariableArea(int interpolationOrder)

Initializes a new instance.

Parameters:

interpolationOrder - The order of the interpolation that will be done to estimate the area.

ScalarVariableArea

protected ScalarVariableArea(ScalarVariableArea existingInstance,
                             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

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 abstract boolean checkForSameDefinition(ScalarVariableArea 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 ScalarVariableArea.checkForSameDefinition(agi.foundation.geometry.Scalar) method.

Overrides:

computeCurrentDefinitionHashCode in class Scalar

Returns:

The computed hash code.

getInterpolationOrder

public final int getInterpolationOrder()

Gets the order of the interpolation that will be done to estimate the area.

setInterpolationOrder

public final void setInterpolationOrder(int value)

Sets the order of the interpolation that will be done to estimate the area.

readFrom

@Nonnull
public static ScalarVariableArea readFrom(@Nonnull
                                                    String fileName)

Reads the variable area information in from a file (most likely a .dat) and returns a ScalarVariableArea.

Parameters:

fileName - Name of the scalar variable area file from which to read.

Returns:

The variable area model described in the file.

Throws:

ArgumentNullException - Thrown when fileName is null.

readFrom

@Nonnull
public static ScalarVariableArea readFrom(@Nonnull
                                                    BufferedReader reader)

Reads the variable area information in from a BufferedReader and returns a ScalarVariableArea

Parameters:

reader - BufferedReader for the .dat file to read.

Returns:

The variable area model described in the file.

Throws:

ArgumentNullException - Thrown when reader is null.