public class CentralBodyLayeredProjectedVolumeAccessConstraint extends AccessConstraint implements ISingleObjectConstraint
ConstrainedObject (get / set) is within any of the extruded convex hulls in any layer then it is considered to be within the volume defined by the access constraint.
Any points that lie above the layer with the maximum height will be discarded. Use care when creating the layers, as a layer with too few points (less than 3) cannot be made into a convex hull and will thus be counted as empty. To be assured that all points are included in the volume you can add a final layer whose height is far above the maximum height of the points (e.g. double.Max as the layer height).
| Modifier and Type | Class and Description |
|---|---|
static class |
CentralBodyLayeredProjectedVolumeAccessConstraint.VolumeLayer
A representation of an individual projected volume used in
CentralBodyLayeredProjectedVolumeAccessConstraint. |
| Modifier | Constructor and Description |
|---|---|
|
CentralBodyLayeredProjectedVolumeAccessConstraint()
Initializes an instance of the layer access constraint, with the default values.
|
|
CentralBodyLayeredProjectedVolumeAccessConstraint(CentralBody centralBody)
|
protected |
CentralBodyLayeredProjectedVolumeAccessConstraint(CentralBodyLayeredProjectedVolumeAccessConstraint existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
CentralBodyLayeredProjectedVolumeAccessConstraint(CentralBody centralBody,
TimeIntervalCollection1<ArrayList<Cartographic>> pointsDefiningConstraintVolume)
Initializes an instance of the constraint with the specified
CentralBody (get / set) and a TimeIntervalCollection1 of the points defining the constraint volume. |
|
CentralBodyLayeredProjectedVolumeAccessConstraint(CentralBody centralBody,
TimeIntervalCollection1<ArrayList<Cartographic>> pointsDefiningConstraintVolume,
IServiceProvider constrainedObjectLocationPointService)
Initializes an instance of the constraint with the specified
CentralBody (get / set) and a TimeIntervalCollection1 of the points defining the constraint volume. |
|
CentralBodyLayeredProjectedVolumeAccessConstraint(TimeIntervalCollection1<ArrayList<Cartographic>> pointsDefiningConstraintVolume,
IServiceProvider constrainedObjectLocationPointService)
Initializes an instance of the constraint with the specified
TimeIntervalCollection1 of the points defining the constraint volume. |
| 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(CentralBodyLayeredProjectedVolumeAccessConstraint 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 |
createEvenlySpacedAltitudeBoundaries(int numberOfLayers,
double maxHeightOfLayers)
A helper method that computes evenly spaced layers from zero to
maxHeightOfLayers. |
void |
enumerateDependencies(DependencyEnumerator enumerator)
Enumerates the dependencies of this object by calling
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. |
ArrayList<Double> |
getAltitudeBoundaries()
Gets the ceiling heights of the altitude layers used to construct the layered volume access constraint.
|
CentralBody |
getCentralBody()
Gets the central body used in this constraint.
|
IServiceProvider |
getConstrainedObject()
Gets the object to which this constraint applies.
|
TimeIntervalCollection1<ArrayList<Cartographic>> |
getPointsDefiningConstraintVolume()
Gets the
Cartographic points that define the constraint volume. |
TimeIntervalCollection1<ArrayList<CentralBodyLayeredProjectedVolumeAccessConstraint.VolumeLayer>> |
getTimeIntervalCollectionOfVolumeLayers()
This helper method will create all of the layers for this constraint for all times data is available.
|
double |
getTolerance()
Gets the tolerance on the constraint value to use when computing the time when this constraint crosses its threshold.
|
void |
setAltitudeBoundaries(ArrayList<Double> value)
Sets the ceiling heights of the altitude layers used to construct the layered volume access constraint.
|
void |
setCentralBody(CentralBody value)
Sets the central body used in this constraint.
|
void |
setConstrainedObject(IServiceProvider value)
Sets the object to which this constraint applies.
|
void |
setPointsDefiningConstraintVolume(TimeIntervalCollection1<ArrayList<Cartographic>> value)
Sets the
Cartographic points that define the constraint volume. |
void |
setTolerance(double value)
Sets the tolerance on the constraint value to use when computing the time when this constraint crosses its threshold.
|
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 CentralBodyLayeredProjectedVolumeAccessConstraint()
CentralBody (get / set) will default to Earth and the Tolerance (get / set) will default to
Constants.Epsilon16.public CentralBodyLayeredProjectedVolumeAccessConstraint(CentralBody centralBody)
CentralBody (get / set). The tolerance defaults to Constants.Epsilon16.centralBody - The central body where the constraint volume points are specified.public CentralBodyLayeredProjectedVolumeAccessConstraint(CentralBody centralBody, TimeIntervalCollection1<ArrayList<Cartographic>> pointsDefiningConstraintVolume)
CentralBody (get / set) and a TimeIntervalCollection1 of the points defining the constraint volume. The associated time intervals
define the duration of validity of the points that comprise the constraint volume. The tolerance defaults to Constants.Epsilon16.centralBody - The central body where the constraint volume points are specified.pointsDefiningConstraintVolume - The points that define the constraint volume.public CentralBodyLayeredProjectedVolumeAccessConstraint(CentralBody centralBody, TimeIntervalCollection1<ArrayList<Cartographic>> pointsDefiningConstraintVolume, IServiceProvider constrainedObjectLocationPointService)
CentralBody (get / set) and a TimeIntervalCollection1 of the points defining the constraint volume. The associated time intervals
define the duration of validity of the points that comprise the constraint volume. The IServiceProvider specifies the object that provides a location, which is to be used to compute access. The tolerance defaults to Constants.Epsilon16.centralBody - The central body where the constraint volume points are specified.pointsDefiningConstraintVolume - The points that define the constraint volume.constrainedObjectLocationPointService - The IServiceProvider of the object that may potentially traverse the volume.public CentralBodyLayeredProjectedVolumeAccessConstraint(TimeIntervalCollection1<ArrayList<Cartographic>> pointsDefiningConstraintVolume, IServiceProvider constrainedObjectLocationPointService)
TimeIntervalCollection1 of the points defining the constraint volume. The associated time intervals
define the duration of validity of the points that comprise the constraint volume. The IServiceProvider specifies the object that provides a location, which is to be used to compute access. The tolerance defaults to Constants.Epsilon16 and the CentralBody (get / set) defaults to Earth (get).pointsDefiningConstraintVolume - The points that define the constraint volume.constrainedObjectLocationPointService - The IServiceProvider of the object that may potentially traverse the volume.protected CentralBodyLayeredProjectedVolumeAccessConstraint(@Nonnull CentralBodyLayeredProjectedVolumeAccessConstraint 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(CentralBodyLayeredProjectedVolumeAccessConstraint 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()
CentralBodyLayeredProjectedVolumeAccessConstraint.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 CentralBody getCentralBody()
public final void setCentralBody(CentralBody value)
public final TimeIntervalCollection1<ArrayList<Cartographic>> getPointsDefiningConstraintVolume()
Cartographic points that define the constraint volume. Each set of points has an associated TimeInterval that
specifies the time window of the points that describe the constraint volume.public final void setPointsDefiningConstraintVolume(TimeIntervalCollection1<ArrayList<Cartographic>> value)
Cartographic points that define the constraint volume. Each set of points has an associated TimeInterval that
specifies the time window of the points that describe the constraint volume.public final IServiceProvider getConstrainedObject()
getConstrainedObject in interface ISingleObjectConstraintpublic final void setConstrainedObject(IServiceProvider value)
setConstrainedObject in interface ISingleObjectConstraintpublic final ArrayList<Double> getAltitudeBoundaries()
public final void setAltitudeBoundaries(ArrayList<Double> value)
public final void createEvenlySpacedAltitudeBoundaries(int numberOfLayers,
double maxHeightOfLayers)
maxHeightOfLayers.
Note that if too many layers are created, it may be possible to have layers with zero points, depending upon the point density of the data set.
numberOfLayers - The desired number of layers.maxHeightOfLayers - The maximum height of the layers.@Nonnull public final TimeIntervalCollection1<ArrayList<CentralBodyLayeredProjectedVolumeAccessConstraint.VolumeLayer>> getTimeIntervalCollectionOfVolumeLayers()
The points defining the constraint, time intervals for point validity, central body, and altitude boundaries must be defined in order to use this method.
TimeIntervalCollection1 of all of the VolumeLayers.PropertyInvalidException - Thrown if PointsDefiningConstraintVolume (get / set) is null or has zero elements, CentralBody (get / set) is null, or if AltitudeBoundaries (get / set) is null or has zero elements.public final double getTolerance()
public final void setTolerance(double value)
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.ArgumentNullException - Thrown when builder or group is null.PropertyInvalidException - Thrown when PointsDefiningConstraintVolume (get / set) is null or has zero elements,
or when CentralBody (get / set), AltitudeBoundaries (get / set), or ConstrainedObject (get / set) is null,
or when Tolerance (get / set) is not greater than zero.ServiceNotAvailableException - Thrown when ILocationPointService is not available on ConstrainedObject (get / set).