public class FieldOfViewExtension extends ObjectExtension implements IFieldOfViewService, IFieldOfViewProjectionService, IFieldOfViewEnclosureService
ObjectExtension that defines a field of view. This is particularly useful for
modeling sensors.| Modifier | Constructor and Description |
|---|---|
|
FieldOfViewExtension()
Initializes a new instance.
|
protected |
FieldOfViewExtension(FieldOfViewExtension existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
FieldOfViewExtension(SensorFieldOfView fieldOfView)
Initializes a new instance with a specified field of view.
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkForSameDefinition(FieldOfViewExtension other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(ObjectExtension 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. |
SensorFieldOfView |
getFieldOfViewVolume()
Gets the volume of the sensor's field of view defined in the sensor's reference frame.
|
Evaluator<Boolean> |
getPointIsInFieldOfViewEvaluator(Point point)
Gets an evaluator to determine if a point is inside the field of view of the sensor at
different dates.
|
Evaluator<Boolean> |
getPointIsInFieldOfViewEvaluator(Point point,
EvaluatorGroup group)
Gets an evaluator to determine if a point is inside the field of view of the sensor at
different dates.
|
SensorProjectionEvaluator |
getSensorProjectionEvaluator(CentralBody centralBody)
Gets an evaluator that can project the field of view of the sensor onto the ellipsoid
surface of a central body.
|
SensorProjectionEvaluator |
getSensorProjectionEvaluator(CentralBody centralBody,
EvaluatorGroup group)
Gets an evaluator that can project the field of view of the sensor onto the ellipsoid
surface of a central body.
|
SensorProjectionEvaluator |
getSensorProjectionEvaluator(CentralBody centralBody,
SensorProjectionOptions projectionOptions)
Gets an evaluator that can project the field of view of the sensor onto the ellipsoid
surface of a central body.
|
SensorProjectionEvaluator |
getSensorProjectionEvaluator(CentralBody centralBody,
SensorProjectionOptions projectionOptions,
EvaluatorGroup group)
Gets an evaluator that can project the field of view of the sensor onto the ellipsoid
surface of a central body.
|
void |
setFieldOfViewVolume(SensorFieldOfView value)
Sets the volume of the sensor's field of view defined in the sensor's reference frame.
|
checkForSameDefinition, getOwner, getServiceareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic FieldOfViewExtension()
public FieldOfViewExtension(SensorFieldOfView fieldOfView)
fieldOfView - The field of view.protected FieldOfViewExtension(@Nonnull FieldOfViewExtension 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(ObjectExtension 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 ObjectExtensionother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(FieldOfViewExtension 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()
FieldOfViewExtension.checkForSameDefinition(agi.foundation.infrastructure.ObjectExtension) method.computeCurrentDefinitionHashCode in class ObjectExtensionpublic 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 ObjectExtensionenumerator - The enumerator that is informed of the dependencies of this object.public final Evaluator<Boolean> getPointIsInFieldOfViewEvaluator(Point point)
getPointIsInFieldOfViewEvaluator in interface IFieldOfViewEnclosureServicepoint - The point to check.public final Evaluator<Boolean> getPointIsInFieldOfViewEvaluator(Point point, EvaluatorGroup group)
getPointIsInFieldOfViewEvaluator in interface IFieldOfViewEnclosureServicepoint - The point to check.group - The group with which to associate the new evaluator. By grouping evaluators
that are often evaluated at the same Julian dates, common computations can be performed only once
for the entire group instead of multiple times for each evaluator.IllegalStateException - Thrown when the Owner (get / set) is null.ArgumentNullException - Thrown when group is null.public final SensorFieldOfView getFieldOfViewVolume()
getFieldOfViewVolume in interface IFieldOfViewServicepublic final void setFieldOfViewVolume(SensorFieldOfView value)
@Nonnull public final SensorProjectionEvaluator getSensorProjectionEvaluator(@Nonnull CentralBody centralBody)
centralBody - The central body onto which to project the sensor.public final SensorProjectionEvaluator getSensorProjectionEvaluator(CentralBody centralBody, SensorProjectionOptions projectionOptions)
getSensorProjectionEvaluator in interface IFieldOfViewProjectionServicecentralBody - The central body onto which to project the sensor.projectionOptions - The options controlling how the sensor is projected, or null to use defaults.@Nonnull public final SensorProjectionEvaluator getSensorProjectionEvaluator(@Nonnull CentralBody centralBody, @Nonnull EvaluatorGroup group)
centralBody - The central body onto which to project the sensor.group - The group with which to associate the new evaluator. By grouping evaluators
that are often evaluated at the same Julian dates, common computations can be performed only once
for the entire group instead of multiple times for each evaluator.IllegalStateException - Thrown when the Owner (get / set) is null.ArgumentNullException - Thrown when group or centralBody is null.public final SensorProjectionEvaluator getSensorProjectionEvaluator(CentralBody centralBody, SensorProjectionOptions projectionOptions, EvaluatorGroup group)
getSensorProjectionEvaluator in interface IFieldOfViewProjectionServicecentralBody - The central body onto which to project the sensor.projectionOptions - The options controlling how the sensor is projected, or null to use defaults.group - The group with which to associate the new evaluator. By grouping evaluators
that are often evaluated at the same Julian dates, common computations can be performed only once
for the entire group instead of multiple times for each evaluator.IllegalStateException - Thrown when the Owner (get / set) is null.ArgumentNullException - Thrown when group or centralBody is null.