Click or drag to resize

CentralBodyLayeredProjectedVolumeAccessConstraint Class

An access constraint that takes a set of points and altitude layers to create a layered volume access constraint. This constraint takes the input points defining the volume and assigns them to the appropriate altitude layer (or layers, as boundaries are inclusive). Within each layer, the points are projected onto an altitude sheet for use with a two dimensional convex hull algorithm. The points are then transformed into a two dimensional convex hull, which is then extruded from the bottom of the layer to the top of the layer, forming a volume. If the ConstrainedObject 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.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Access.Constraints
Assembly:  AGI.Foundation.Platforms (in AGI.Foundation.Platforms.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public class CentralBodyLayeredProjectedVolumeAccessConstraint : AccessConstraint, 
	ISingleObjectConstraint

The CentralBodyLayeredProjectedVolumeAccessConstraint type exposes the following members.

Constructors
  NameDescription
Public methodCentralBodyLayeredProjectedVolumeAccessConstraint
Initializes an instance of the layer access constraint, with the default values. The CentralBody will default to Earth and the Tolerance will default to Epsilon16.
Public methodCentralBodyLayeredProjectedVolumeAccessConstraint(CentralBody)
Initializes an instance of the constraint with the specified CentralBody. The tolerance defaults to Epsilon16.
Public methodCentralBodyLayeredProjectedVolumeAccessConstraint(TimeIntervalCollectionListCartographic, IServiceProvider)
Initializes an instance of the constraint with the specified TimeIntervalCollectionT 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 Epsilon16 and the CentralBody defaults to Earth.
Public methodCentralBodyLayeredProjectedVolumeAccessConstraint(CentralBody, TimeIntervalCollectionListCartographic)
Initializes an instance of the constraint with the specified CentralBody and a TimeIntervalCollectionT 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 Epsilon16.
Protected methodCentralBodyLayeredProjectedVolumeAccessConstraint(CentralBodyLayeredProjectedVolumeAccessConstraint, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodCentralBodyLayeredProjectedVolumeAccessConstraint(CentralBody, TimeIntervalCollectionListCartographic, IServiceProvider)
Initializes an instance of the constraint with the specified CentralBody and a TimeIntervalCollectionT 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 Epsilon16.
Top
Properties
  NameDescription
Public propertyAltitudeBoundaries
Gets or sets the ceiling heights of the altitude layers used to construct the layered volume access constraint.
Public propertyApplicability
Gets or sets the Access situation in which this constraint applies.
(Inherited from AccessConstraint.)
Public propertyCentralBody
Gets or sets the central body used in this constraint.
Public propertyConstrainedObject
Gets or sets the object to which this constraint applies.
Public propertyDebuggingLogger
Gets or sets a logger to which debugging information will be written.
(Inherited from AccessQuery.)
Public propertyEvaluationOrder
Gets or sets a number indicating the evaluation order of this constraint relative to other constraints. All constraints involved in an AccessComputation or that share a common parent (e.g. AccessQueryAnd or AccessQueryOr) in an AccessQuery are sorted by this value before being evaluated in ascending order, so constraints with a lower evaluation order are evaluated earlier than constraints with a higher evaluation order.
(Inherited from AccessConstraint.)
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 propertyPointsDefiningConstraintVolume
Gets or sets the 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 propertySampling
Gets an instance describing how this constraint is to be sampled.
(Inherited from AccessConstraint.)
Public propertyTolerance
Gets or sets the tolerance on the constraint value to use when computing the time when this constraint crosses its threshold.
Top
Methods
  NameDescription
Public methodBuildQueryEvaluator
Builds a query evaluator from this constraint.
(Overrides AccessConstraintBuildQueryEvaluator(ConstraintQueryBuilder, EvaluatorGroup).)
Protected methodCheckForSameDefinition(AccessConstraint)
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 AccessConstraintCheckForSameDefinition(AccessConstraint).)
Protected methodCheckForSameDefinition(AccessQuery)
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 AccessConstraint.)
Protected methodCheckForSameDefinition(CentralBodyLayeredProjectedVolumeAccessConstraint)
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).
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 AccessQuery.)
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 AccessConstraintComputeCurrentDefinitionHashCode.)
Public methodCreateEvenlySpacedAltitudeBoundaries
A helper method that computes evenly spaced layers from zero to the input .
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 AccessConstraintEnumerateDependencies(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 AccessConstraint.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetEvaluationOrder
Returns EvaluationOrder, indicating the suggested evaluation order of this constraint when it is used as part of an AccessQuery. Queries that hold sub-queries (such as an AccessQueryAnd) generally evaluate their sub-queries in ascending order of this value, so constraints with a lower evaluation order are evaluated earlier than constraints with a higher evaluation order.
(Inherited from AccessConstraint.)
Public methodGetEvaluator
Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
(Inherited from AccessQuery.)
Public methodGetEvaluator(IServiceProvider)
Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
(Inherited from AccessQuery.)
Public methodGetEvaluator(IServiceProvider, EvaluatorGroup)
Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
(Inherited from AccessConstraint.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetTimeIntervalCollectionOfVolumeLayers
This helper method will create all of the layers for this constraint for all times data is available.
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 methodToDisjunctiveNormalForm
Transforms this query to disjunctive normal form (DNF).
(Inherited from AccessConstraint.)
Public methodToString
Returns a string that represents the current object.
(Overrides ObjectToString.)
Top
Remarks
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).
See Also