agi.foundation.celestial

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

Class IndividualPlateModel

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.celestial.IndividualPlateModel

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

DragPlate, SolarRadiationPlate

public abstract class IndividualPlateModel
extends DefinitionalObject

A model of a discrete surface element of a spacecraft that has a surface area, unit normal direction, and drag or reflectivity coefficients.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IndividualPlateModel(IndividualPlateModel existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
protected	IndividualPlateModel(String plateName, String groupName, double referenceArea) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
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(IndividualPlateModel 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.
String	getGroupName() Gets the name of the group of plates that contains this plate.
String	getPlateName() Gets the name of the individual plate.
double	getReferenceArea() Gets the surface area of this plate in meters squared.
abstract Vector	getUnitNormalVector(Axes bodyAxes, Vector toSunVector) Gets the unit normal vector of the plate that describes its pointing and is used to determine how much of the plate's ReferenceArea (get / set) is directed toward the Sun (for SolarRadiationPlates) or toward the incoming atmosphere (for DragPlates).
void	setGroupName(String value) Sets the name of the group of plates that contains this plate.
void	setPlateName(String value) Sets the name of the individual plate.
void	setReferenceArea(double value) Sets the surface area of this plate in meters squared.

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

IndividualPlateModel

protected IndividualPlateModel(String plateName,
                               String groupName,
                               double referenceArea)

Initializes a new instance.

Parameters:

plateName - The name of the individual plate.

groupName - The name of the group of plates that contains this plate. (E.g. Body or SolarPanels.)

referenceArea - The surface area of this plate in meters squared.

IndividualPlateModel

protected IndividualPlateModel(@Nonnull
                               IndividualPlateModel 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(IndividualPlateModel 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 IndividualPlateModel.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getPlateName

public final String getPlateName()

Gets the name of the individual plate.

setPlateName

public final void setPlateName(String value)

Sets the name of the individual plate.

getGroupName

public final String getGroupName()

Gets the name of the group of plates that contains this plate. (E.g. Body or SolarPanels.)

setGroupName

public final void setGroupName(String value)

Sets the name of the group of plates that contains this plate. (E.g. Body or SolarPanels.)

getReferenceArea

public final double getReferenceArea()

Gets the surface area of this plate in meters squared.

setReferenceArea

public final void setReferenceArea(double value)

Sets the surface area of this plate in meters squared.

getUnitNormalVector

public abstract Vector getUnitNormalVector(Axes bodyAxes,
                                           Vector toSunVector)

Gets the unit normal vector of the plate that describes its pointing and is used to determine how much of the plate's ReferenceArea (get / set) is directed toward the Sun (for SolarRadiationPlates) or toward the incoming atmosphere (for DragPlates).

Parameters:

bodyAxes - The attitude of the spacecraft containing this plate.

toSunVector - The direction to the Sun that is used to determine the pointing of Solar panel plates.

Returns:

The unit normal vector of the plate that describes its pointing