public class AltitudeConstraint extends MinimumMaximumAccessConstraint implements ISingleObjectConstraint
ConstrainedObject (get / set) is above a minimum and
below a maximum altitude in meters with respect to the given central body. Altitude is measured orthogonally from
the subpoint of the ConstrainedObject (get / set) object on the surface of the central body's ellipsoid.
This constraint requires that the ConstrainedObject (get / set) provide
ILocationPointService.
This constraint obtains the altitude using the evaluator returned by
CentralBody.observeCartographicPoint(Point,EvaluatorGroup).
MinimumMaximumAccessConstraint.MinMaxThresholdEvaluator| Modifier | Constructor and Description |
|---|---|
|
AltitudeConstraint()
Initializes a new instance with default values.
|
protected |
AltitudeConstraint(AltitudeConstraint existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
AltitudeConstraint(CentralBody centralBody,
double maximumValue)
Initializes a new instance with the specified central body and maximum value.
|
|
AltitudeConstraint(CentralBody centralBody,
double minimumValue,
double maximumValue)
Initializes a new instance with the specified central body, minimum value, and maximum value.
|
|
AltitudeConstraint(double maximumValue)
Initializes a new instance with the specified maximum value.
|
|
AltitudeConstraint(double minimumValue,
double maximumValue)
Initializes a new instance with the specified minimum value and maximum value.
|
|
AltitudeConstraint(IServiceProvider constrainedObject,
CentralBody centralBody,
double maximumValue)
Initializes a new instance with the specified constrained object, central body, and maximum value.
|
|
AltitudeConstraint(IServiceProvider constrainedObject,
CentralBody centralBody,
double minimumValue,
double maximumValue)
Initializes a new instance with the specified constrained object, central body, minimum value, and maximum value.
|
|
AltitudeConstraint(IServiceProvider constrainedObject,
double maximumValue)
Initializes a new instance with the specified constrained object and maximum value.
|
|
AltitudeConstraint(IServiceProvider constrainedObject,
double minimumValue,
double maximumValue)
Initializes a new instance with the specified constrained object, minimum value, and maximum value.
|
| Modifier and Type | Method and Description |
|---|---|
void |
buildQueryEvaluator(ConstraintQueryBuilder builder,
EvaluatorGroup group)
Builds a query evaluator from this constraint.
|
protected boolean |
checkForSameDefinition(AltitudeConstraint 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. |
CentralBody |
getCentralBody()
Gets the central body relative to which the altitude is computed.
|
IServiceProvider |
getConstrainedObject()
Gets the object to which this constraint applies.
|
void |
setCentralBody(CentralBody value)
Sets the central body relative to which the altitude is computed.
|
void |
setConstrainedObject(IServiceProvider value)
Sets the object to which this constraint applies.
|
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 AltitudeConstraint()
This constructor initializes the CentralBody (get / set) property to the Earth (get)
instance that is in the CentralBodiesFacet instance in the CalculationContext.
Before evaluating this constraint using AccessComputation, the user must set the
MinimumValue (get / set) property,
the MaximumValue (get / set) property, or both. Before evaluating this constraint
as part of an AccessQuery, it is also necessary to set the ConstrainedObject (get / set) property.
public AltitudeConstraint(CentralBody centralBody, double maximumValue)
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 necessary to set the ConstrainedObject (get / set) property.
centralBody - The central body relative to which the altitude is computed.maximumValue - The maximum allowed altitude value, in meters.public AltitudeConstraint(IServiceProvider constrainedObject, CentralBody centralBody, double maximumValue)
This constraint is ready for use with both AccessComputation and AccessQuery
after being constructed using this constructor.
constrainedObject - The object to which this constraint is applied.centralBody - The central body relative to which the altitude is computed.maximumValue - The maximum allowed altitude value, in meters.public AltitudeConstraint(double maximumValue)
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 necessary to set the ConstrainedObject (get / set) property.
maximumValue - The maximum allowed altitude value, in meters.public AltitudeConstraint(IServiceProvider constrainedObject, double maximumValue)
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.
constrainedObject - The object to which this constraint is applied.maximumValue - The maximum allowed altitude value, in meters.public AltitudeConstraint(CentralBody centralBody, double minimumValue, double maximumValue)
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 necessary to set the ConstrainedObject (get / set) property.
centralBody - The central body relative to which the altitude is computed.minimumValue - The minimum allowed altitude value, in meters.maximumValue - The maximum allowed altitude value, in meters.public AltitudeConstraint(IServiceProvider constrainedObject, CentralBody centralBody, double minimumValue, double maximumValue)
This constraint is ready for use with both AccessComputation and AccessQuery
after being constructed using this constructor.
constrainedObject - The object to which this constraint is applied.centralBody - The central body relative to which the altitude is computed.minimumValue - The minimum allowed altitude value, in meters.maximumValue - The maximum allowed altitude value, in meters.public AltitudeConstraint(double minimumValue,
double maximumValue)
This constructor initializes CentralBody (get / set) 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 necessary to set the ConstrainedObject (get / set) property.
minimumValue - The minimum allowed altitude value, in meters.maximumValue - The maximum allowed altitude value, in meters.public AltitudeConstraint(IServiceProvider constrainedObject, double minimumValue, double maximumValue)
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.
constrainedObject - The object to which this constraint is applied.minimumValue - The minimum allowed altitude value, in meters.maximumValue - The maximum allowed altitude value, in meters.protected AltitudeConstraint(@Nonnull AltitudeConstraint 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(AltitudeConstraint 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()
AltitudeConstraint.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 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 IServiceProvider getConstrainedObject()
AccessComputation.getConstrainedObject in interface ISingleObjectConstraintpublic final void setConstrainedObject(IServiceProvider value)
AccessComputation.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.