agi.foundation.platforms

(agi.foundation.platforms-2023r1.jar)

Class CentralBodySurfaceRegion

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.infrastructure.ObjectExtension

agi.foundation.platforms.CentralBodySurfaceRegion

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider, ICentralBodySurfaceRegionService

public class CentralBodySurfaceRegion
extends ObjectExtension
implements ICentralBodySurfaceRegionService

A region (or polygon) on the surface of a CentralBody (get / set). This class can be used alone or as an ObjectExtension when ICentralBodySurfaceRegionService is required, such as when computing access with a CentralBodySurfaceRegionElevationAngleConstraint.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CentralBodySurfaceRegion() Initializes a new instance.
	CentralBodySurfaceRegion(CentralBody centralBody, EllipsoidSurfaceRegion surfaceRegion) Initializes a new instance as a surface region on a specified central body.
	CentralBodySurfaceRegion(CentralBody centralBody, Iterable<Cartographic> points) Initializes a new instance as a polygon defined by a set of planetodetic cartographic points on a specified associated central body.
protected	CentralBodySurfaceRegion(CentralBodySurfaceRegion 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(CentralBodySurfaceRegion other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(ObjectExtension 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.
CentralBody	getCentralBody() Gets the central body providing the orientation and topology of the SurfaceRegion (get / set), and on which the region is defined.
EllipsoidSurfaceRegion	getSurfaceRegion() Gets the definition of the region on the surface of the central body.
void	setCentralBody(CentralBody value) Sets the central body providing the orientation and topology of the SurfaceRegion (get / set), and on which the region is defined.
void	setSurfaceRegion(EllipsoidSurfaceRegion value) Sets the definition of the region on the surface of the central body.

Methods inherited from class agi.foundation.infrastructure.ObjectExtension

checkForSameDefinition, getOwner, getService

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

CentralBodySurfaceRegion

public CentralBodySurfaceRegion()

Initializes a new instance. SurfaceRegion (get / set) and CentralBody (get / set) must be set before this instance is used.

CentralBodySurfaceRegion

public CentralBodySurfaceRegion(@Nonnull
                                CentralBody centralBody,
                                @Nonnull
                                Iterable<Cartographic> points)

Initializes a new instance as a polygon defined by a set of planetodetic cartographic points on a specified associated central body.

Parameters:

centralBody - The central body providing the topology and orientation of the polygon, and on which the polygon is defined.

points - The ordered planetodetic vertices of the polygon. The last point is automatically connected with the first.

CentralBodySurfaceRegion

public CentralBodySurfaceRegion(CentralBody centralBody,
                                EllipsoidSurfaceRegion surfaceRegion)

Initializes a new instance as a surface region on a specified central body.

Parameters:

centralBody - The central body providing the topology and orientation of the surfaceRegion, and on which the region is defined. The ReferenceSurface (get) property of the surfaceRegion is expected to match the Shape (get / set) of this central body.

surfaceRegion - The region on the surface of the centralBody.

CentralBodySurfaceRegion

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

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

Overrides:

computeCurrentDefinitionHashCode in class ObjectExtension

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 ObjectExtension

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getSurfaceRegion

public final EllipsoidSurfaceRegion getSurfaceRegion()

Gets the definition of the region on the surface of the central body. The ReferenceSurface (get) property of this instance is expected to match the Shape (get / set) of the CentralBody (get / set).

Specified by:

getSurfaceRegion in interface ICentralBodySurfaceRegionService

setSurfaceRegion

public final void setSurfaceRegion(EllipsoidSurfaceRegion value)

Sets the definition of the region on the surface of the central body. The ReferenceSurface (get) property of this instance is expected to match the Shape (get / set) of the CentralBody (get / set).

getCentralBody

public final CentralBody getCentralBody()

Gets the central body providing the orientation and topology of the SurfaceRegion (get / set), and on which the region is defined. The ReferenceSurface (get) property of the SurfaceRegion (get / set) is expected to match the Shape (get / set) of this central body.

Specified by:

getCentralBody in interface ICentralBodySurfaceRegionService

setCentralBody

public final void setCentralBody(CentralBody value)

Sets the central body providing the orientation and topology of the SurfaceRegion (get / set), and on which the region is defined. The ReferenceSurface (get) property of the SurfaceRegion (get / set) is expected to match the Shape (get / set) of this central body.