Click or drag to resize

EntityDynamicSensorFieldOfViewTEntity Class

A DynamicSensorFieldOfView that gets the current sensor shape from a tracking entity implementing IEntitySensorFieldOfView. This type can only be used in an evaluator that is parameterized on EntityParameter and TransactionParameter.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.Geometry.ShapesDynamicSensorFieldOfView
      AGI.Foundation.Geometry.ShapesEntityDynamicSensorFieldOfViewTEntity

Namespace:  AGI.Foundation.Geometry.Shapes
Assembly:  AGI.Foundation.Tracking (in AGI.Foundation.Tracking.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax
public class EntityDynamicSensorFieldOfView<TEntity> : DynamicSensorFieldOfView
where TEntity : class, IEntitySensorFieldOfView

Type Parameters

TEntity
The type of entity.

The EntityDynamicSensorFieldOfViewTEntity type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyEntityParameter
Gets or sets the entity parameter specifying the entity from which this object should get its field of view.
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertyTransactionParameter
Gets or sets the transaction parameter specifying the transaction that will be used when obtaining information from the entity.
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(DefinitionalObject)
Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from DynamicSensorFieldOfView.)
Protected methodCheckForSameDefinition(DynamicSensorFieldOfView)
Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides DynamicSensorFieldOfViewCheckForSameDefinition(DynamicSensorFieldOfView).)
Protected methodCheckForSameDefinition(EntityDynamicSensorFieldOfViewTEntity)
Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
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 CheckForSameDefinition(DefinitionalObject) method.
(Overrides DynamicSensorFieldOfViewComputeCurrentDefinitionHashCode.)
Public methodEnumerateDependencies
Enumerates the dependencies of this object by calling EnumerateT(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.
(Overrides DefinitionalObjectEnumerateDependencies(DependencyEnumerator).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
Called by Freeze to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.
(Inherited from DefinitionalObject.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetEvaluator
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 GetRepresentativeFieldOfView for more information.
(Inherited from DynamicSensorFieldOfView.)
Public methodGetEvaluator(EvaluatorGroup)
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 GetRepresentativeFieldOfView for more information.
(Overrides DynamicSensorFieldOfViewGetEvaluator(EvaluatorGroup).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetRepresentativeFieldOfView
Gets a SensorFieldOfView that is representative of the ones that are produced by evaluating the DynamicSensorFieldOfViewEvaluator returned by GetEvaluator. In many cases, this property can be . 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 GetEnclosureDescriptions.
(Overrides DynamicSensorFieldOfViewGetRepresentativeFieldOfView.)
Public methodGetService
Gets the service object of the specified type.
(Inherited from DynamicSensorFieldOfView.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also