public class CovarianceSeparationConstraint extends MinimumMaximumAccessConstraint implements ILinkConstraint
ConstrainedLink (get / set) with uncertain position have a 'worst-case' separation
above a minimum and below a maximum distance in meters. This separation is determined by using the ILocationPointCovarianceService
provided by the ends of the constrained link, if one is available. The uncertainty ellipsoid is modeled, and the calculated separation represents
the distance between the two points on the surface of the ellipsoids which are closest to one another.
This constraint requires that both ends of the ConstrainedLink (get / set) provide ILocationPointService.
If either end of the constrained link provide ILocationPointCovarianceService an uncertainty ellipsoid will be
created from GetEllipsoidSizeEvaluator, the
relevant TransmitterSigmaFactor (get / set) ReceiverSigmaFactor (get / set).
and the OrientationAxes (get) of the covariance.
If an end of the link does not provide ILocationPointCovarianceService the position will be treated as an exact point.
If neither end provides an ILocationPointCovarianceService the results of this Constraint will be equivalent to using
a RangeConstraint.
This constraint computes range as the magnitude of displacement vector between the two objects.
MinimumMaximumAccessConstraint.MinMaxThresholdEvaluator| Modifier | Constructor and Description |
|---|---|
|
CovarianceSeparationConstraint()
Initializes a new instance with default values.
|
protected |
CovarianceSeparationConstraint(CovarianceSeparationConstraint existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
CovarianceSeparationConstraint(double minimumValue)
Initializes a new instance with the specified minimum value.
|
|
CovarianceSeparationConstraint(double minimumValue,
double maximumValue)
Initializes a new instance with the specified minimum value and maximum value.
|
|
CovarianceSeparationConstraint(IServiceProvider constrainedLink,
double minimumValue)
Initializes a new instance with the specified constrained link, constrained link end, and minimum value.
|
|
CovarianceSeparationConstraint(IServiceProvider constrainedLink,
double minimumValue,
double maximumValue)
Initializes a new instance with the specified constrained link, constrained link end, 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(CovarianceSeparationConstraint 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 |
getConstrainedLink()
Gets the link to which this constraint applies.
|
LinkRole |
getConstrainedLinkEnd()
Gets the end of the link to which this constraint applies.
|
Scalar |
getReceiverSigmaFactor()
Gets the number of standard deviations of position uncertainty to take into account for the
Receiver (get). |
Scalar |
getTransmitterSigmaFactor()
Gets the number of standard deviations of position uncertainty to take into account for the
Transmitter (get). |
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 |
setReceiverSigmaFactor(Scalar value)
Sets the number of standard deviations of position uncertainty to take into account for the
Receiver (get). |
void |
setTransmitterSigmaFactor(Scalar value)
Sets the number of standard deviations of position uncertainty to take into account for the
Transmitter (get). |
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 CovarianceSeparationConstraint()
Before evaluating this constraint as part of an AccessQuery, the user must set the
MinimumValue (get / set) property,
the MaximumValue (get / set) property, or both, as well as
the ConstrainedLink (get / set) property.
By default, TransmitterSigmaFactor (get / set) and ReceiverSigmaFactor (get / set) are set to a
ScalarFixed of 2.7954832077026364, which corresponds to a 95% confidence
interval for a three-dimensional Gaussian distribution. GaussianStatistics.multiDimensionalStandardDeviationFactor(int, double)
can be used to calculate replacement values if a different Confidence Interval is required.
public CovarianceSeparationConstraint(double minimumValue)
This constraint is ready for use as an AccessConstraintsExtension 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) property.
By default, TransmitterSigmaFactor (get / set) and ReceiverSigmaFactor (get / set) are set to a
ScalarFixed of 2.7954832077026364, which corresponds to a 95% confidence
interval for a three-dimensional Gaussian distribution. GaussianStatistics.multiDimensionalStandardDeviationFactor(int, double)
can be used to calculate replacement values if a different Confidence Interval is required.
minimumValue - The minimum value, in meters.public CovarianceSeparationConstraint(IServiceProvider constrainedLink, double minimumValue)
Initializes a new instance with the specified constrained link, constrained link end, and minimum value.
By default, TransmitterSigmaFactor (get / set) and ReceiverSigmaFactor (get / set) are set to a
ScalarFixed of 2.7954832077026364, which corresponds to a 95% confidence
interval for a three-dimensional Gaussian distribution. GaussianStatistics.multiDimensionalStandardDeviationFactor(int, double)
can be used to calculate replacement values if a different Confidence Interval is required.
constrainedLink - The link to which this constraint is applied.minimumValue - The minimum value, in meters.public CovarianceSeparationConstraint(double minimumValue,
double maximumValue)
This constraint is ready for use as an AccessConstraintsExtension 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) property.
By default, TransmitterSigmaFactor (get / set) and ReceiverSigmaFactor (get / set) are set to a
ScalarFixed of 2.7954832077026364, which corresponds to a 95% confidence
interval for a three-dimensional Gaussian distribution. GaussianStatistics.multiDimensionalStandardDeviationFactor(int, double)
can be used to calculate replacement values if a different Confidence Interval is required.
minimumValue - The minimum value, in meters.maximumValue - The maximum value, in meters.public CovarianceSeparationConstraint(IServiceProvider constrainedLink, double minimumValue, double maximumValue)
By default, TransmitterSigmaFactor (get / set) and ReceiverSigmaFactor (get / set) are set to a
ScalarFixed of 2.7954832077026364, which corresponds to a 95% confidence
interval for a three-dimensional Gaussian distribution. GaussianStatistics.multiDimensionalStandardDeviationFactor(int, double)
can be used to calculate replacement values if a different Confidence Interval is required.
constrainedLink - The link to which this constraint is applied.minimumValue - The minimum value, in meters.maximumValue - The maximum value, in meters.protected CovarianceSeparationConstraint(@Nonnull CovarianceSeparationConstraint 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(CovarianceSeparationConstraint 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()
CovarianceSeparationConstraint.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()
getConstrainedLinkEnd in interface ILinkConstraintpublic final void setConstrainedLinkEnd(@Nonnull LinkRole value)
setConstrainedLinkEnd in interface ILinkConstraintpublic final Scalar getTransmitterSigmaFactor()
Transmitter (get).
By default, this is set to a ScalarFixed of 2.7954832077026364, which corresponds to a 95% confidence
interval for a three-dimensional Gaussian distribution. GaussianStatistics.multiDimensionalStandardDeviationFactor(int, double)
can be used to calculate replacement values if a different Confidence Interval is required.public final void setTransmitterSigmaFactor(Scalar value)
Transmitter (get).
By default, this is set to a ScalarFixed of 2.7954832077026364, which corresponds to a 95% confidence
interval for a three-dimensional Gaussian distribution. GaussianStatistics.multiDimensionalStandardDeviationFactor(int, double)
can be used to calculate replacement values if a different Confidence Interval is required.public final Scalar getReceiverSigmaFactor()
Receiver (get).
By default, this is set to a ScalarFixed of 2.7954832077026364, which corresponds to a 95% confidence
interval for a three-dimensional Gaussian distribution. GaussianStatistics.multiDimensionalStandardDeviationFactor(int, double)
can be used to calculate replacement values if a different Confidence Interval is required.public final void setReceiverSigmaFactor(Scalar value)
Receiver (get).
By default, this is set to a ScalarFixed of 2.7954832077026364, which corresponds to a 95% confidence
interval for a three-dimensional Gaussian distribution. GaussianStatistics.multiDimensionalStandardDeviationFactor(int, double)
can be used to calculate replacement values if a different Confidence Interval is required.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.