agi.foundation.access.constraints

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

Class CentralBodyEllipticCylindricalAccessConstraint

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.access.AccessQuery

agi.foundation.access.AccessConstraint

agi.foundation.access.constraints.CentralBodyEllipticCylindricalAccessConstraint

All Implemented Interfaces:

ISingleObjectConstraint, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class CentralBodyEllipticCylindricalAccessConstraint
extends AccessConstraint
implements ISingleObjectConstraint

An access constraint in the shape of an elliptic cylinder (or a circular cylinder by setting the x semiaxis length equal to the y semiaxis length) defined by a central point, a heading for the x semiaxis, and the corresponding x semiaxis and y semiaxis lengths. This cylinder is located on the surface of the supplied central body and extends outwardly in the direction of the surface normal. If a cylinder banded in altitude is desired, then use this constraint in conjunction with AltitudeConstraint.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CentralBodyEllipticCylindricalAccessConstraint.ModelFidelity Indicates the model to be used.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CentralBodyEllipticCylindricalAccessConstraint(CentralBodyEllipticCylindricalAccessConstraint existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	CentralBodyEllipticCylindricalAccessConstraint(IServiceProvider constrainedObject, IServiceProvider ellipseCenterLocation, Scalar ellipseHeading, Scalar xSemiaxisLength, Scalar ySemiaxisLength) Initializes a new instance with the specified values, with the Earth as the central body and the fidelity set to high.
	CentralBodyEllipticCylindricalAccessConstraint(IServiceProvider constrainedObject, IServiceProvider ellipseCenterLocation, Scalar ellipseHeading, Scalar xSemiaxisLength, Scalar ySemiaxisLength, CentralBody centralBody, CentralBodyEllipticCylindricalAccessConstraint.ModelFidelity fidelity) Initializes a new instance with the specified values.
	CentralBodyEllipticCylindricalAccessConstraint(IServiceProvider constrainedObject, IServiceProvider ellipseCenterLocation, Scalar ellipseHeading, Scalar xSemiaxisLength, Scalar ySemiaxisLength, CentralBodyEllipticCylindricalAccessConstraint.ModelFidelity fidelity) Initializes a new instance with the specified values, with the Earth as the central body.

Method Summary

Modifier and Type	Method and Description
void	buildQueryEvaluator(ConstraintQueryBuilder builder, EvaluatorGroup group) Builds a query evaluator from this constraint.
protected boolean	checkForSameDefinition(AccessConstraint other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(CentralBodyEllipticCylindricalAccessConstraint 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 on which the constraint is defined.
IServiceProvider	getConstrainedObject() Gets the object to which this constraint applies.
IServiceProvider	getEllipseCenterLocation() Gets the elliptic cylinder's center point.
Scalar	getEllipseHeading() Gets the angle between North and the x semiaxis of the constraint ellipse.
CentralBodyEllipticCylindricalAccessConstraint.ModelFidelity	getFidelity() Gets the model's fidelity.
Scalar	getXSemiaxisLength() Gets the constraint ellipse x semiaxis length.
Scalar	getYSemiaxisLength() Gets the constraint ellipse y semiaxis length.
void	setCentralBody(CentralBody value) Sets the central body on which the constraint is defined.
void	setConstrainedObject(IServiceProvider value) Sets the object to which this constraint applies.
void	setEllipseCenterLocation(IServiceProvider value) Sets the elliptic cylinder's center point.
void	setEllipseHeading(Scalar value) Sets the angle between North and the x semiaxis of the constraint ellipse.
void	setFidelity(CentralBodyEllipticCylindricalAccessConstraint.ModelFidelity value) Sets the model's fidelity.
void	setXSemiaxisLength(Scalar value) Sets the constraint ellipse x semiaxis length.
void	setYSemiaxisLength(Scalar value) Sets the constraint ellipse y semiaxis length.
String	toString() Returns a string representing the ellipse used in this constraint.

Methods inherited from class agi.foundation.access.AccessConstraint

checkForSameDefinition, freezeAggregatedObjects, getApplicability, getEvaluationOrder, getEvaluator, getSampling, setApplicability, setEvaluationOrder, toDisjunctiveNormalForm

Methods inherited from class agi.foundation.access.AccessQuery

and, and, anyPath, anyPath, anyPath, anyPath, anyPath, anyPath, atLeastN, atMostN, checkForSameDefinition, exactlyN, fromObject, fromObjectAllowNoConstraints, getDebuggingLogger, getEvaluator, getEvaluator, not, or, or, setDebuggingLogger

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, 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, wait, wait, wait

Constructor Detail

CentralBodyEllipticCylindricalAccessConstraint

public CentralBodyEllipticCylindricalAccessConstraint(IServiceProvider constrainedObject,
                                                      IServiceProvider ellipseCenterLocation,
                                                      Scalar ellipseHeading,
                                                      Scalar xSemiaxisLength,
                                                      Scalar ySemiaxisLength)

Initializes a new instance with the specified values, with the Earth as the central body and the fidelity set to high.

Parameters:

constrainedObject - Location of the object with which the constraint is calculated against.

ellipseCenterLocation - The center location of the elliptic cylinder.

ellipseHeading - The angle from North (in radians) of the x semiaxis.

xSemiaxisLength - The x semiaxis length of the elliptic cylinder.

ySemiaxisLength - The y semiaxis length of the elliptic cylinder.

CentralBodyEllipticCylindricalAccessConstraint

public CentralBodyEllipticCylindricalAccessConstraint(IServiceProvider constrainedObject,
                                                      IServiceProvider ellipseCenterLocation,
                                                      Scalar ellipseHeading,
                                                      Scalar xSemiaxisLength,
                                                      Scalar ySemiaxisLength,
                                                      @Nonnull
                                                      CentralBodyEllipticCylindricalAccessConstraint.ModelFidelity fidelity)

Initializes a new instance with the specified values, with the Earth as the central body.

Parameters:

constrainedObject - Location of the object with which the constraint is calculated against.

ellipseCenterLocation - The center location of the elliptic cylinder.

ellipseHeading - The angle from North (in radians) of the x semiaxis.

xSemiaxisLength - The x semiaxis length of the elliptic cylinder.

ySemiaxisLength - The y semiaxis length of the elliptic cylinder.

fidelity - Selects if the body is approximated as a simple sphere.

CentralBodyEllipticCylindricalAccessConstraint

public CentralBodyEllipticCylindricalAccessConstraint(IServiceProvider constrainedObject,
                                                      IServiceProvider ellipseCenterLocation,
                                                      Scalar ellipseHeading,
                                                      Scalar xSemiaxisLength,
                                                      Scalar ySemiaxisLength,
                                                      CentralBody centralBody,
                                                      @Nonnull
                                                      CentralBodyEllipticCylindricalAccessConstraint.ModelFidelity fidelity)

Initializes a new instance with the specified values.

Parameters:

constrainedObject - Location of the object with which the constraint is calculated against.

ellipseCenterLocation - The center location of the elliptic cylinder.

ellipseHeading - The angle from North (in radians) of the x semiaxis.

xSemiaxisLength - The x semiaxis length of the elliptic cylinder.

ySemiaxisLength - The y semiaxis length of the elliptic cylinder.

centralBody - The central body on which the elliptic cylinder is constructed.

fidelity - Selects if the body is approximated as a simple sphere.

CentralBodyEllipticCylindricalAccessConstraint

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

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(CentralBodyEllipticCylindricalAccessConstraint 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 CentralBodyEllipticCylindricalAccessConstraint.checkForSameDefinition(agi.foundation.access.AccessConstraint) method.

Overrides:

computeCurrentDefinitionHashCode in class AccessConstraint

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 AccessConstraint

Parameters:

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

getEllipseCenterLocation

public final IServiceProvider getEllipseCenterLocation()

Gets the elliptic cylinder's center point. This service provider must provide the ILocationPointService service.

setEllipseCenterLocation

public final void setEllipseCenterLocation(IServiceProvider value)

Sets the elliptic cylinder's center point. This service provider must provide the ILocationPointService service.

getEllipseHeading

public final Scalar getEllipseHeading()

Gets the angle between North and the x semiaxis of the constraint ellipse.

setEllipseHeading

public final void setEllipseHeading(Scalar value)

Sets the angle between North and the x semiaxis of the constraint ellipse.

getXSemiaxisLength

public final Scalar getXSemiaxisLength()

Gets the constraint ellipse x semiaxis length.

setXSemiaxisLength

public final void setXSemiaxisLength(Scalar value)

Sets the constraint ellipse x semiaxis length.

getYSemiaxisLength

public final Scalar getYSemiaxisLength()

Gets the constraint ellipse y semiaxis length.

setYSemiaxisLength

public final void setYSemiaxisLength(Scalar value)

Sets the constraint ellipse y semiaxis length.

getCentralBody

public final CentralBody getCentralBody()

Gets the central body on which the constraint is defined.

setCentralBody

public final void setCentralBody(CentralBody value)

Sets the central body on which the constraint is defined.

getFidelity

@Nonnull
public final CentralBodyEllipticCylindricalAccessConstraint.ModelFidelity getFidelity()

Gets the model's fidelity.

setFidelity

public final void setFidelity(@Nonnull
                              CentralBodyEllipticCylindricalAccessConstraint.ModelFidelity value)

Sets the model's fidelity.

getConstrainedObject

public final IServiceProvider getConstrainedObject()

Gets the object to which this constraint applies. It is not necessary to set this property when using this constraint with AccessComputation.

Specified by:

getConstrainedObject in interface ISingleObjectConstraint

setConstrainedObject

public final void setConstrainedObject(IServiceProvider value)

Sets the object to which this constraint applies. It is not necessary to set this property when using this constraint with AccessComputation.

Specified by:

setConstrainedObject in interface ISingleObjectConstraint

toString

public String toString()

Returns a string representing the ellipse used in this constraint.

Overrides:

toString in class Object

Returns:

A string representing the ellipse.

buildQueryEvaluator

public void buildQueryEvaluator(ConstraintQueryBuilder builder,
                                EvaluatorGroup group)

Builds a query evaluator from this constraint.

Specified by:

buildQueryEvaluator in class AccessConstraint

Parameters:

builder - The builder instance to use to build the evaluator.

group - The evaluator group in which to create individual constraint function evaluators.