public class DilutionOfPrecisionConstraint extends MinimumMaximumAccessConstraint implements ISingleObjectConstraint
ConstrainedObject (get / set) to when the dilution of
precision (DOP) is above a minimum, below a maximum or both.
This constraint requires that the ConstrainedObject (get / set) provide IGpsReceiverService.
This constraint computes DOP using the evaluator returned by
GpsReceiver.getDilutionOfPrecisionEvaluator().
MinimumMaximumAccessConstraint.MinMaxThresholdEvaluator| Modifier | Constructor and Description |
|---|---|
|
DilutionOfPrecisionConstraint()
Initializes a new instance with default values.
|
protected |
DilutionOfPrecisionConstraint(DilutionOfPrecisionConstraint existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
DilutionOfPrecisionConstraint(double maximumValue,
DilutionOfPrecisionType valueToConstrain)
Initializes a new instance with the specified maximum value and DOP value to constrain.
|
|
DilutionOfPrecisionConstraint(IServiceProvider constrainedObject,
double maximumValue,
DilutionOfPrecisionType valueToConstrain)
Initializes a new instance with the specified constrained object, maximum value, and DOP value to constrain.
|
| Modifier and Type | Method and Description |
|---|---|
void |
buildQueryEvaluator(ConstraintQueryBuilder builder,
EvaluatorGroup group)
Builds a query evaluator from this constraint.
|
protected boolean |
checkForSameDefinition(DilutionOfPrecisionConstraint 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. |
IServiceProvider |
getConstrainedObject()
Gets an object which provides the
IGpsReceiverService to which this constraint applies. |
Duration |
getMaximumStepsize()
Gets the maximum step size allowed for sampling this constraint.
|
DilutionOfPrecisionType |
getValueToConstrain()
Gets the type of dilution of precision to use for this constraint.
|
void |
setConstrainedObject(IServiceProvider value)
Sets an object which provides the
IGpsReceiverService to which this constraint applies. |
void |
setMaximumStepsize(Duration value)
Sets the maximum step size allowed for sampling this constraint.
|
void |
setValueToConstrain(DilutionOfPrecisionType value)
Sets the type of dilution of precision to use for this constraint.
|
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 DilutionOfPrecisionConstraint()
Before evaluating this constraint using AccessComputation, the user must set the
MinimumValue (get / set) property,
the MaximumValue (get / set) property, or both.
Setting the ValueToConstrain (get / set) property as well is highly recommended.
Before evaluating this constraint
as part of an AccessQuery, it is also necessary to set the ConstrainedObject (get / set) property.
public DilutionOfPrecisionConstraint(double maximumValue,
@Nonnull
DilutionOfPrecisionType valueToConstrain)
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 - Maximum allowable dilution of precision.valueToConstrain - The type of dilution of precision to compute.public DilutionOfPrecisionConstraint(IServiceProvider constrainedObject, double maximumValue, @Nonnull DilutionOfPrecisionType valueToConstrain)
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 - Maximum allowable dilution of precision.valueToConstrain - The type of dilution of precision to compute.protected DilutionOfPrecisionConstraint(@Nonnull DilutionOfPrecisionConstraint 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(DilutionOfPrecisionConstraint 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()
DilutionOfPrecisionConstraint.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 getConstrainedObject()
IGpsReceiverService to which this constraint applies.
It is not necessary to set this property when using this constraint with AccessComputation.getConstrainedObject in interface ISingleObjectConstraintpublic final void setConstrainedObject(IServiceProvider value)
IGpsReceiverService to which this constraint applies.
It is not necessary to set this property when using this constraint with AccessComputation.setConstrainedObject in interface ISingleObjectConstraint@Nonnull public final DilutionOfPrecisionType getValueToConstrain()
public final void setValueToConstrain(@Nonnull DilutionOfPrecisionType value)
@Nonnull public final Duration getMaximumStepsize()
In most cases, constraints use relative motion or derivative information to provide intelligent sampling. In the case of navigation constraints, the functions are highly discontinuous as navigation satellites come in and out of view. So, this step size represents the largest time interval which may be overlooked by the sampling. In other words, if the max step is 60 seconds, access may miss an interval less than 60 seconds in duration if the function jumps without any indication of a boundary crossing into or leaving the interval. If two steps are on opposite sides of the boundary, the constraint will subsample to find the exact time.
public final void setMaximumStepsize(@Nonnull Duration value)
In most cases, constraints use relative motion or derivative information to provide intelligent sampling. In the case of navigation constraints, the functions are highly discontinuous as navigation satellites come in and out of view. So, this step size represents the largest time interval which may be overlooked by the sampling. In other words, if the max step is 60 seconds, access may miss an interval less than 60 seconds in duration if the function jumps without any indication of a boundary crossing into or leaving the interval. If two steps are on opposite sides of the boundary, the constraint will subsample to find the exact time.
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.