public class CentralBodySurfaceRegionElevationAngleConstraint extends MinimumMaximumAccessConstraint implements ILinkConstraint
AccessConstraint that requires that an object be between a span of elevation angles
from any or all of the points in a given area on the surface of the CentralBody (get / set).
Elevation is the angle between the relative position vector, measured from any given point along the line to
the other object, and the plane tangent to the surface of the CentralBody (get / set) at a point on or inside the boundary
of the surface region.
Elevation is measured as positive away from the CentralBody (get / set).
This constraint requires that the ConstrainedLinkEnd (get / set) of the ConstrainedLink (get / set)
provide the ICentralBodySurfaceRegionService and that the other end of the link provide
the ILocationPointService.
The motion is computed from the PointEvaluator obtained from the ILocationPointService of the
non-constrained end of the ConstrainedLink (get / set). The calculation uses the ICentralBodySurfaceRegionService to
tell whether the object at the other end of the link is inside or outside the EllipsoidSurfaceRegion of the CentralBodySurfaceRegion
and to obtain the boundary. Elevation is calculated based on the surface normals on the Ellipsoid.
It is not recommended that the user use this constraint with elevation angles below zero while using a large area target which spans more than half the globe.
MinimumMaximumAccessConstraint.MinMaxThresholdEvaluator| Modifier | Constructor and Description |
|---|---|
|
CentralBodySurfaceRegionElevationAngleConstraint()
Initializes a new instance with default values.
|
|
CentralBodySurfaceRegionElevationAngleConstraint(CentralBody centralBody,
double minimumElevation)
Initializes a new instance with the specified
CentralBody and minimum value. |
protected |
CentralBodySurfaceRegionElevationAngleConstraint(CentralBodySurfaceRegionElevationAngleConstraint existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
CentralBodySurfaceRegionElevationAngleConstraint(double minimumElevation)
Initializes a new instance with the specified minimum value.
|
|
CentralBodySurfaceRegionElevationAngleConstraint(IServiceProvider constrainedLink,
LinkRole constrainedLinkEnd,
CentralBody centralBody,
double minimumElevation)
Initializes a new instance with the specified constrained link, constrained link end,
CentralBody,
and minimum value. |
|
CentralBodySurfaceRegionElevationAngleConstraint(IServiceProvider constrainedLink,
LinkRole constrainedLinkEnd,
double minimumElevation)
Initializes a new instance with the specified constrained link, constrained link end, and minimum value.
|
| Modifier and Type | Method and Description |
|---|---|
void |
buildQueryEvaluator(ConstraintQueryBuilder builder,
EvaluatorGroup group)
Builds a query evaluator from this constraint.
|
protected boolean |
checkForSameDefinition(CentralBodySurfaceRegionElevationAngleConstraint other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(MinimumMaximumAccessConstraint 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. |
boolean |
getAccessToWholeObject()
Gets a value indicating whether to constrain based on any or all points in the area definition.
|
CentralBody |
getCentralBody()
Gets the central body relative to which the elevation is computed.
|
IServiceProvider |
getConstrainedLink()
Gets the link to which this constraint applies.
|
LinkRole |
getConstrainedLinkEnd()
Gets the end of the link to which this constraint applies.
|
double |
getGranularity()
Gets the maximum angular distance in radians between sample points along the boundary of the area.
|
void |
setAccessToWholeObject(boolean value)
Sets a value indicating whether to constrain based on any or all points in the area definition.
|
void |
setCentralBody(CentralBody value)
Sets the central body relative to which the elevation is computed.
|
void |
setConstrainedLink(IServiceProvider value)
Sets the link to which this constraint applies.
|
void |
setConstrainedLinkEnd(LinkRole value)
Sets the end of the link to which this constraint applies.
|
void |
setGranularity(double value)
Sets the maximum angular distance in radians between sample points along the boundary of the area.
|
String |
toString()
Returns a string representation of the object.
|
checkForSameDefinition, getIsMaximumEnabled, getIsMinimumEnabled, getMaximumTolerance, getMaximumValue, getMinimumTolerance, getMinimumValue, setIsMaximumEnabled, setIsMinimumEnabled, setMaximumTolerance, setMaximumValue, setMinimumTolerance, setMinimumValuecheckForSameDefinition, 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 CentralBodySurfaceRegionElevationAngleConstraint()
This constructor initializes the CentralBody (get / set) property to the Earth (get)
instance that is in the CentralBodiesFacet instance in the CalculationContext.
It also sets the MinimumValue (get / set) property to 0.0 radians.
Before evaluating this constraint as part of an AccessQuery, it is necessary
to set the ConstrainedLink (get / set) and ConstrainedLinkEnd (get / set) properties.
public CentralBodySurfaceRegionElevationAngleConstraint(CentralBody centralBody, double minimumElevation)
CentralBody and minimum value.
This constraint is ready for use with AccessComputation after being constructed using
this constructor. However, before evaluating this constraint
as part of an AccessQuery, it is also necessary to set the ConstrainedLink (get / set) and
ConstrainedLinkEnd (get / set) properties.
centralBody - The CentralBody relative to which the elevation angle is computed.minimumElevation - The minimum required elevation angle, in radians.public CentralBodySurfaceRegionElevationAngleConstraint(IServiceProvider constrainedLink, @Nonnull LinkRole constrainedLinkEnd, CentralBody centralBody, double minimumElevation)
CentralBody,
and minimum value.
This constraint is ready for use with both AccessComputation and AccessQuery
after being constructed using this constructor.
constrainedLink - The link to which this constraint is applied.constrainedLinkEnd - The end of the link that is observing the elevation angle to the other object.centralBody - The CentralBody relative to which the elevation is computed.minimumElevation - The minimum required elevation angle, in radians.public CentralBodySurfaceRegionElevationAngleConstraint(double minimumElevation)
This constructor initializes the CentralBody (get / set) property to the Earth (get)
instance that is in the CentralBodiesFacet instance in the CalculationContext.
This constraint is ready for use with AccessComputation after being constructed using
this constructor. However, before evaluating this constraint
as part of an AccessQuery, it is also necessary to set the ConstrainedLink (get / set) and
ConstrainedLinkEnd (get / set) properties.
minimumElevation - The minimum required elevation angle, in radians.public CentralBodySurfaceRegionElevationAngleConstraint(IServiceProvider constrainedLink, @Nonnull LinkRole constrainedLinkEnd, double minimumElevation)
This constructor initializes the CentralBody (get / set) property to the Earth (get)
instance that is in the CentralBodiesFacet instance in the CalculationContext.
This constraint is ready for use with both AccessComputation and AccessQuery
after being constructed using this constructor.
constrainedLink - The link to which this constraint is applied.constrainedLinkEnd - The end of the link that is observing the elevation angle to the other object.minimumElevation - The minimum required elevation angle, in radians.protected CentralBodySurfaceRegionElevationAngleConstraint(@Nonnull CentralBodySurfaceRegionElevationAngleConstraint 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(MinimumMaximumAccessConstraint 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 MinimumMaximumAccessConstraintother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(CentralBodySurfaceRegionElevationAngleConstraint 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()
CentralBodySurfaceRegionElevationAngleConstraint.checkForSameDefinition(agi.foundation.access.MinimumMaximumAccessConstraint) method.computeCurrentDefinitionHashCode in class MinimumMaximumAccessConstraintpublic 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 getConstrainedLink()
AccessComputation.getConstrainedLink in interface ILinkConstraintpublic final void setConstrainedLink(IServiceProvider value)
AccessComputation.setConstrainedLink in interface ILinkConstraint@Nonnull public final LinkRole getConstrainedLinkEnd()
AccessComputation.getConstrainedLinkEnd in interface ILinkConstraintpublic final void setConstrainedLinkEnd(@Nonnull LinkRole value)
AccessComputation.setConstrainedLinkEnd in interface ILinkConstraintpublic final CentralBody getCentralBody()
By default, the value of this property is the EarthCentralBody in the
CentralBodiesFacet instance in the CalculationContext.
public final void setCentralBody(CentralBody value)
By default, the value of this property is the EarthCentralBody in the
CentralBodiesFacet instance in the CalculationContext.
public final double getGranularity()
By default, this is 0.5 degrees or 0.008726646 radians.
public final void setGranularity(double value)
By default, this is 0.5 degrees or 0.008726646 radians.
public final boolean getAccessToWholeObject()
By default, this is false, constraining based on any point inside or on the boundary.
public final void setAccessToWholeObject(boolean value)
By default, this is false, constraining based on any point inside or on the boundary.
public 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.