agi.foundation.geometry.shapes

(agi.foundation.core-2024r2.jar)

Class DynamicSensorFieldOfView

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.geometry.shapes.DynamicSensorFieldOfView

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider

Direct Known Subclasses:

EntityDynamicSensorFieldOfView

public abstract class DynamicSensorFieldOfView
extends DefinitionalObject
implements IServiceProvider

A sensor field-of-view volume that can change shape with time.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DynamicSensorFieldOfView() Initializes a new instance.
protected	DynamicSensorFieldOfView(DynamicSensorFieldOfView existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(DynamicSensorFieldOfView other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
DynamicSensorFieldOfViewEvaluator	getEvaluator() Gets an evaluator that can be used to find the shape of the sensor field-of-view volume at a given date.
abstract DynamicSensorFieldOfViewEvaluator	getEvaluator(EvaluatorGroup group) Gets an evaluator that can be used to find the shape of the sensor field-of-view volume at a given date.
abstract SensorFieldOfView	getRepresentativeFieldOfView() Gets a SensorFieldOfView that is representative of the ones that are produced by evaluating the DynamicSensorFieldOfViewEvaluator returned by DynamicSensorFieldOfView.getEvaluator().
Object	getService(Class<?> serviceType) Gets the service object of the specified type.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DynamicSensorFieldOfView

protected DynamicSensorFieldOfView()

Initializes a new instance.

DynamicSensorFieldOfView

protected DynamicSensorFieldOfView(@Nonnull
                                   DynamicSensorFieldOfView existingInstance,
                                   @Nonnull
                                   CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject other)

Checks to determine if another instance has the same definition as this instance and returns 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).

Specified by:

checkForSameDefinition in class DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected abstract boolean checkForSameDefinition(DynamicSensorFieldOfView other)

Checks to determine if another instance has the same definition as this instance and returns 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).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the DynamicSensorFieldOfView.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getService

@Nullable
public Object getService(@Nonnull
                                    Class<?> serviceType)

Gets the service object of the specified type.

Specified by:

getService in interface IServiceProvider

Parameters:

serviceType - An object that specifies the type of service object to get.

Returns:

The found service, or null if the service does not exist.

Throws:

ArgumentNullException - Thrown when serviceType is null.

getEvaluator

@Nonnull
public final DynamicSensorFieldOfViewEvaluator getEvaluator()

Gets an evaluator that can be used to find the shape of the sensor field-of-view volume at a given date. While this evaluator is allowed to return completely different types of sensors at different times, some clients of this class, such as SensorVolumeConstraint, require more consistency. See DynamicSensorFieldOfView.getRepresentativeFieldOfView() for more information.

Returns:

The evaluator.

getEvaluator

@Nonnull
public abstract DynamicSensorFieldOfViewEvaluator getEvaluator(@Nonnull
                                                                         EvaluatorGroup group)

Gets an evaluator that can be used to find the shape of the sensor field-of-view volume at a given date. While this evaluator is allowed to return completely different types of sensors at different times, some clients of this class, such as SensorVolumeConstraint, require more consistency. See DynamicSensorFieldOfView.getRepresentativeFieldOfView() for more information.

Parameters:

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.

Returns:

The evaluator.

getRepresentativeFieldOfView

public abstract SensorFieldOfView getRepresentativeFieldOfView()

Gets a SensorFieldOfView that is representative of the ones that are produced by evaluating the DynamicSensorFieldOfViewEvaluator returned by DynamicSensorFieldOfView.getEvaluator(). In many cases, this property can be null. However, when using this sensor with SensorVolumeConstraint to constrain access over an interval, this property must return a representative instance so that access can be set up properly. The representative instance must by the same type (such as ComplexConic or RectangularPyramid) as the instances returned by the evaluator. Furthermore, the general shape of the sensor must be the same. For example, if the representative sensor has a hole, then all sensors returned by the evaluator must have holes as well. The size of the hole is still allowed to change with time, however. To be precise, this method must return a SensorFieldOfView with the exact same number of items in the collection returned by Solid.getEnclosureDescriptions().

Returns:

The SensorFieldOfView defined by this.