public class CentralBodySurfaceRegionConstraint extends AccessConstraint implements ISingleObjectConstraint
AccessConstraint that requires that an object be within a given CentralBodySurfaceRegion.
This constraint is built upon a CentralBodySurfaceRegionElevationAngleConstraint with minimum and maximum elevation angles set to 90.0 degrees
in order to determine when the object is directly above or within the given area.
This constraint requires that the SurfaceRegion (get / set) provide the ICentralBodySurfaceRegionService and that the
ConstrainedObject (get / set) provide the ILocationPointService.
The motion of the object is computed using the PointEvaluator obtained from the ILocationPointService of the ConstrainedObject (get / set).
The calculation uses the ICentralBodySurfaceRegionService of the SurfaceRegion (get / set) to determine whether the object is inside or outside the
CentralBodySurfaceRegion and to obtain the boundary.
| Modifier | Constructor and Description |
|---|---|
protected |
CentralBodySurfaceRegionConstraint(CentralBodySurfaceRegionConstraint existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
CentralBodySurfaceRegionConstraint(EllipsoidSurfaceRegion surfaceRegion,
IServiceProvider constrainedObject)
Initializes a new instance with the specified surface region and object.
|
|
CentralBodySurfaceRegionConstraint(EllipsoidSurfaceRegion surfaceRegion,
IServiceProvider constrainedObject,
CentralBody centralBody)
Initializes a new instance with the specified region, object, and
CentralBody. |
|
CentralBodySurfaceRegionConstraint(IServiceProvider surfaceRegion,
IServiceProvider constrainedObject)
Initializes a new instance with the specified region and object.
|
|
CentralBodySurfaceRegionConstraint(Iterable<Cartographic> surfaceRegion,
IServiceProvider constrainedObject)
Initializes a new instance with the specified region and object.
|
|
CentralBodySurfaceRegionConstraint(Iterable<Cartographic> surfaceRegion,
IServiceProvider constrainedObject,
CentralBody centralBody)
Initializes a new instance with the specified surfaceRegion, object, and
CentralBody. |
| 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(CentralBodySurfaceRegionConstraint 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. |
IServiceProvider |
getConstrainedObject()
Gets the object to which this constraint is applied.
|
IServiceProvider |
getSurfaceRegion()
Gets the surface region.
|
void |
setConstrainedObject(IServiceProvider value)
Sets the object to which this constraint is applied.
|
void |
setSurfaceRegion(IServiceProvider value)
Sets the surface region.
|
String |
toString()
Returns a string representation of the object.
|
checkForSameDefinition, freezeAggregatedObjects, getApplicability, getEvaluationOrder, getEvaluator, getSampling, setApplicability, setEvaluationOrder, toDisjunctiveNormalFormand, and, anyPath, anyPath, anyPath, anyPath, anyPath, anyPath, atLeastN, atMostN, checkForSameDefinition, exactlyN, fromObject, fromObjectAllowNoConstraints, getDebuggingLogger, getEvaluator, getEvaluator, not, or, or, setDebuggingLoggerareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic CentralBodySurfaceRegionConstraint(EllipsoidSurfaceRegion surfaceRegion, IServiceProvider constrainedObject)
This constructor initializes the CentralBody (get / set) property of the SurfaceRegion (get / set) to the
Earth (get) instance that is in the CentralBodiesFacet instance in the CalculationContext
as the CentralBody (get / set).
surfaceRegion - The EllipsoidSurfaceRegion with which the SurfaceRegion (get / set) is initialized.constrainedObject - The object to which this constraint is applied.public CentralBodySurfaceRegionConstraint(@Nonnull Iterable<Cartographic> surfaceRegion, IServiceProvider constrainedObject)
This constructor initializes the CentralBody (get / set) property of the SurfaceRegion (get / set) to the
Earth (get) instance that is in the CentralBodiesFacet instance in the CalculationContext
as the CentralBody (get / set).
public CentralBodySurfaceRegionConstraint(EllipsoidSurfaceRegion surfaceRegion, IServiceProvider constrainedObject, CentralBody centralBody)
CentralBody.surfaceRegion - The EllipsoidSurfaceRegion with which the SurfaceRegion (get / set) is initialized.constrainedObject - The object to which this constraint is applied.centralBody - The CentralBody with which the SurfaceRegion (get / set) is initialized.public CentralBodySurfaceRegionConstraint(@Nonnull Iterable<Cartographic> surfaceRegion, IServiceProvider constrainedObject, CentralBody centralBody)
CentralBody.surfaceRegion - The ordered planetodetic vertices of region with which the SurfaceRegion (get / set). The last vertex is
automatically connected with the first.constrainedObject - The object to which this constraint is applied.centralBody - The CentralBody with which the SurfaceRegion (get / set) is initialized.public CentralBodySurfaceRegionConstraint(IServiceProvider surfaceRegion, IServiceProvider constrainedObject)
surfaceRegion - The surface region.constrainedObject - The object to which this constraint is applied.protected CentralBodySurfaceRegionConstraint(@Nonnull CentralBodySurfaceRegionConstraint existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor
in a derived class.
existingInstance - The existing instance to copy.context - A CopyContext that controls the depth of the copy.ArgumentNullException - Thrown when existingInstance or context is null.public Object clone(CopyContext 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:
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:
CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the
same CopyContext passed to the constructor.
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;clone in interface ICloneWithContextclone in class DefinitionalObjectcontext - The context to use to perform the copy.protected final boolean checkForSameDefinition(AccessConstraint other)
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).checkForSameDefinition in class AccessConstraintother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(CentralBodySurfaceRegionConstraint other)
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).other - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
CentralBodySurfaceRegionConstraint.checkForSameDefinition(agi.foundation.access.AccessConstraint) method.computeCurrentDefinitionHashCode in class AccessConstraintpublic void enumerateDependencies(DependencyEnumerator enumerator)
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.enumerateDependencies in interface IEnumerateDependenciesenumerateDependencies in class AccessConstraintenumerator - The enumerator that is informed of the dependencies of this object.public final IServiceProvider getSurfaceRegion()
ICentralBodySurfaceRegionService.public final void setSurfaceRegion(IServiceProvider value)
ICentralBodySurfaceRegionService.public final IServiceProvider getConstrainedObject()
ILocationPointService.getConstrainedObject in interface ISingleObjectConstraintpublic final void setConstrainedObject(IServiceProvider value)
ILocationPointService.setConstrainedObject in interface ISingleObjectConstraintpublic String toString()
java.lang.ObjecttoString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
public void buildQueryEvaluator(ConstraintQueryBuilder builder, EvaluatorGroup group)
buildQueryEvaluator in class AccessConstraintbuilder - The builder instance to use to build the evaluator.group - The evaluator group in which to create individual constraint function evaluators.