agi.foundation.celestial

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

Class TorqueModel

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.celestial.TorqueModel

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

ConstantTorque, GravityGradientTorque, MagneticCoilTorque, OffAxisTorque, ReactionWheelTorque

public abstract class TorqueModel
extends DefinitionalObject

Represents a torque which can be used to specify the equations of rotational motion for a rigid-body parameterized by a PropagationEulerianAxes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TorqueModel() Initializes a new instance.
protected	TorqueModel(TorqueModel existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
abstract void	buildTorqueEvaluator(ResultantTorqueBuilder builder, EvaluatorGroup group) Build lists of torques based on this model in order to create an overall resultant torque.
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(TorqueModel 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.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
protected void	freezeAggregatedObjects() Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object.
TorqueEvaluator	getTorqueEvaluator() Gets an instance of an evaluator that can compute the torque.
TorqueEvaluator	getTorqueEvaluator(EvaluatorGroup group) Gets an instance of an evaluator that can compute the torque.
Vector	getTorqueVector() Gets the Vector representation of this torque.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, 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

TorqueModel

protected TorqueModel()

Initializes a new instance.

TorqueModel

protected TorqueModel(@Nonnull
                      TorqueModel 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

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject 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 DefinitionalObject

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(TorqueModel 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 TorqueModel.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

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.

freezeAggregatedObjects

protected void freezeAggregatedObjects()

Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.

Overrides:

freezeAggregatedObjects in class DefinitionalObject

getTorqueVector

@Nonnull
public Vector getTorqueVector()

Gets the Vector representation of this torque.

getTorqueEvaluator

@Nonnull
public final TorqueEvaluator getTorqueEvaluator()

Gets an instance of an evaluator that can compute the torque.

Returns:

The evaluator that computes the torque.

getTorqueEvaluator

@Nonnull
public TorqueEvaluator getTorqueEvaluator(@Nonnull
                                                    EvaluatorGroup group)

Gets an instance of an evaluator that can compute the torque.

Parameters:

group - The group in which to create the evaluator and its dependents.

Returns:

The evaluator that computes the torque.

Throws:

ArgumentNullException - Thrown when group is null.

buildTorqueEvaluator

public abstract void buildTorqueEvaluator(@Nonnull
                                          ResultantTorqueBuilder builder,
                                          @Nonnull
                                          EvaluatorGroup group)

Build lists of torques based on this model in order to create an overall resultant torque.

Parameters:

builder - The builder object containing the lists and additional information on the Axes in which the overall resultant is defined.

group - The evaluator group in which to create evaluators.