agi.foundation.celestial

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

Class SolarRadiationPlate

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.celestial.IndividualPlateModel

agi.foundation.celestial.SolarRadiationPlate

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

SolarRadiationBodyPlate, SolarRadiationOneDofSolarPanelPlate, SolarRadiationTwoDofSolarPanelPlate

public abstract class SolarRadiationPlate
extends IndividualPlateModel

A model of a discrete surface element of a spacecraft that has a surface area, unit normal direction, a specular reflectivity coefficient, and a diffuse reflectivity coefficient.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(IndividualPlateModel other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(SolarRadiationPlate 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.
double	getDiffuseReflectivity() Gets the dimensionless diffuse reflectivity coefficient of this plate (that should be between zero and one).
double	getSpecularReflectivity() Gets the dimensionless specular reflectivity coefficient of this plate (that should be between zero and one).
Scalar	getSwitchingScalar(Axes bodyAxes, Vector toSunVector) Gets a scalar that is used to determine whether this plate is facing a direction within 90 degrees of the incident sunlight direction at a given time.
void	setDiffuseReflectivity(double value) Sets the dimensionless diffuse reflectivity coefficient of this plate (that should be between zero and one).
void	setSpecularReflectivity(double value) Sets the dimensionless specular reflectivity coefficient of this plate (that should be between zero and one).

Methods inherited from class agi.foundation.celestial.IndividualPlateModel

checkForSameDefinition, getGroupName, getPlateName, getReferenceArea, getUnitNormalVector, setGroupName, setPlateName, setReferenceArea

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

SolarRadiationPlate

protected SolarRadiationPlate(String plateName,
                              String groupName,
                              double referenceArea,
                              double specularReflectivity,
                              double diffuseReflectivity)

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.

specularReflectivity - The dimensionless specular reflectivity coefficient of this plate (that should be between zero and one).

diffuseReflectivity - The dimensionless diffuse reflectivity coefficient of this plate (that should be between zero and one).

SolarRadiationPlate

protected SolarRadiationPlate(@Nonnull
                              SolarRadiationPlate 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(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).

Specified by:

checkForSameDefinition in class IndividualPlateModel

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(SolarRadiationPlate 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 SolarRadiationPlate.checkForSameDefinition(agi.foundation.celestial.IndividualPlateModel) method.

Overrides:

computeCurrentDefinitionHashCode in class IndividualPlateModel

Returns:

The computed hash code.

getSpecularReflectivity

public final double getSpecularReflectivity()

Gets the dimensionless specular reflectivity coefficient of this plate (that should be between zero and one).

setSpecularReflectivity

public final void setSpecularReflectivity(double value)

Sets the dimensionless specular reflectivity coefficient of this plate (that should be between zero and one).

getDiffuseReflectivity

public final double getDiffuseReflectivity()

Gets the dimensionless diffuse reflectivity coefficient of this plate (that should be between zero and one).

setDiffuseReflectivity

public final void setDiffuseReflectivity(double value)

Sets the dimensionless diffuse reflectivity coefficient of this plate (that should be between zero and one).

getSwitchingScalar

@Nonnull
public final Scalar getSwitchingScalar(Axes bodyAxes,
                                                 @Nonnull
                                                 Vector toSunVector)

Gets a scalar that is used to determine whether this plate is facing a direction within 90 degrees of the incident sunlight direction at a given time.

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:

A scalar that is used to determine whether this plate is facing the incident sunlight at a given time.