agi.foundation.celestial

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

Class SolarRadiationBodyPlate

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.celestial.IndividualPlateModel

agi.foundation.celestial.SolarRadiationPlate

agi.foundation.celestial.SolarRadiationBodyPlate

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class SolarRadiationBodyPlate
extends SolarRadiationPlate

A model of a discrete surface element of a spacecraft's body 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	SolarRadiationBodyPlate(SolarRadiationBodyPlate existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	SolarRadiationBodyPlate(String plateName, String groupName, double referenceArea, UnitCartesian unitNormalCartesian, double specularReflectivity, double diffuseReflectivity) Initializes a new instance.
	SolarRadiationBodyPlate(String plateName, String groupName, double referenceArea, UnitCartesian unitNormalCartesian, double specularReflectivity, double diffuseReflectivity, Axes pointingAxes) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(SolarRadiationBodyPlate other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(SolarRadiationPlate 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.
Axes	getPointingAxes() Gets the axes that are used to define the pointing of this plate.
UnitCartesian	getUnitNormalCartesian() Gets a parameter that specifies the direction of this plate in body-fixed or pointing axis-fixed coordinates.
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	setPointingAxes(Axes value) Sets the axes that are used to define the pointing of this plate.
void	setUnitNormalCartesian(UnitCartesian value) Sets a parameter that specifies the direction of this plate in body-fixed or pointing axis-fixed coordinates.

Methods inherited from class agi.foundation.celestial.SolarRadiationPlate

checkForSameDefinition, getDiffuseReflectivity, getSpecularReflectivity, getSwitchingScalar, setDiffuseReflectivity, setSpecularReflectivity

Methods inherited from class agi.foundation.celestial.IndividualPlateModel

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

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

SolarRadiationBodyPlate

public SolarRadiationBodyPlate(String plateName,
                               String groupName,
                               double referenceArea,
                               @Nonnull
                               UnitCartesian unitNormalCartesian,
                               double specularReflectivity,
                               double diffuseReflectivity)

Initializes a new instance. The PointingAxes (get / set) are set to null so that the body axes are not overriden by the pointing axes.

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.

unitNormalCartesian - A parameter that specifies the direction of this plate in body-fixed or pointing axis-fixed coordinates.

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).

SolarRadiationBodyPlate

public SolarRadiationBodyPlate(String plateName,
                               String groupName,
                               double referenceArea,
                               @Nonnull
                               UnitCartesian unitNormalCartesian,
                               double specularReflectivity,
                               double diffuseReflectivity,
                               Axes pointingAxes)

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.

unitNormalCartesian - A parameter that specifies the direction of this plate in body-fixed or pointing axis-fixed coordinates.

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).

pointingAxes - The axes that are used to define the pointing of this plate. (These override the body-axes when determining the unit normal direction if they are not null).

SolarRadiationBodyPlate

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

Specified by:

checkForSameDefinition in class SolarRadiationPlate

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

Overrides:

computeCurrentDefinitionHashCode in class SolarRadiationPlate

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.

getUnitNormalCartesian

@Nonnull
public final UnitCartesian getUnitNormalCartesian()

Gets a parameter that specifies the direction of this plate in body-fixed or pointing axis-fixed coordinates.

setUnitNormalCartesian

public final void setUnitNormalCartesian(@Nonnull
                                         UnitCartesian value)

Sets a parameter that specifies the direction of this plate in body-fixed or pointing axis-fixed coordinates.

getPointingAxes

@Nullable
public final Axes getPointingAxes()

Gets the axes that are used to define the pointing of this plate. (These override the body-axes when determining the unit normal direction if they are not null).

setPointingAxes

public final void setPointingAxes(@Nullable
                                  Axes value)

Sets the axes that are used to define the pointing of this plate. (These override the body-axes when determining the unit normal direction if they are not null).

getUnitNormalVector

@Nonnull
public 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).

SolarRadiationBodyPlates override the body axes with their PointingAxes (get / set) if their pointing axes are not null. The pointing direction within those axes is given by the UnitNormalCartesian (get / set).

Specified by:

getUnitNormalVector in class IndividualPlateModel

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