Click or drag to resize

CoverageDefinitionOnCentralBody Class

Note: This API is now obsolete.

Provides a convenient way to organize and initialize a coverage calculation, which computes access calculations over a set of grid point. Each access calculation represents a logical operation determining whether a set of constraints are satisfied for geometry involving one grid point and any number of other assets.

This class uses different threads to loop over a set of grid points. So, after configuring the grid and assets, the grid generation and coverage calculations will automatically divide the grid point calculations between threads unless MultithreadCoverage is set to false or the ThreadingPolicy is configured to use only one thread.

As an alternative, consider using DiscreteCoverageDefinitionOnCentralBody, which loops over time instead of looping over the grid and can in some cases provide better performance.

Inheritance Hierarchy
SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.CoverageCoverageDefinitionOnCentralBody

Namespace:  AGI.Foundation.Coverage
Assembly:  AGI.Foundation.Spatial (in AGI.Foundation.Spatial.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
[ObsoleteAttribute("The coverage system has markedly changed. See ParameterizedSpatiallyPartitionedCoverageDefinition or MaterializedSpatiallyPartitionedCoverageDefinition.")]
public class CoverageDefinitionOnCentralBody : DefinitionalObject

The CoverageDefinitionOnCentralBody type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAssets
Gets the list of assets which provide coverage over the grid.
Public propertyCentralBody
Gets or sets the central body on which the Grid is defined. This provides the ReferenceFrame information for the grid points when used in access calculations.
Public propertyFilter
Gets or sets the constraint which indicates the bound on the number of assets which must have access to a grid point in order to provide coverage.
Public propertyGrid
Gets or sets the scheme of the grid used to generate points of interest over which to analyze coverage.
Public propertyGridPointCreationMethod
Gets or sets the method used to take any given grid point and create a service provider which can be used in access calculations. For the default, see comments on: CreateGridPointForAccess(CoverageGridPoint).
Public propertyGridPointPlaceholder
Gets a placeholder which can be used to represent any given grid point for creating calculations which are performed for each grid point. Use this object when creating queries which involve grid points in a coverage computation. When the computation is performed, this will be replaced with the appropriate grid point object created by GridPointCreationMethod.
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 propertyMultithreadCoverage
Gets or sets a flag indicating whether to use multiple threads to compute coverage. When coverage is multithreaded, the access computations that are performed for each grid point are not themselves multithreaded. In most cases this will result in best utilization of multiple processor cores. However, if the number of grid points is small or the individual access computations for each grid point are very expensive, it may be desirable to disable multithreading at the coverage level by setting this property to and allowing the parallelism to happen within each access computation.
Public propertyStoreGridCellBoundaries
Gets or sets a flag indicating whether to use extra memory to store the boundary vertices for the grid cell of each CoverageGridPoint. This information is useful for rendering the exact surface region represented by each grid point when visualizing results. Alternately, the EllipsoidGrid can reproduce these boundaries from any given EllipsoidGridPoint generated from the gridding algorithm.
Top
Methods
  NameDescription
Public methodAddAsset(AssetDefinition)
Add an asset to the coverage definition.
Public methodAddAsset(Object, AccessQuery)
Add an asset to the coverage definition.
Public methodAddAssetRange
Add a range of assets to the coverage definition.
Protected methodCheckForSameDefinition(CoverageDefinitionOnCentralBody)
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).
(Overrides DefinitionalObjectCheckForSameDefinition(DefinitionalObject).)
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Public methodComputeCoverageOverTheGrid(TimeIntervalCollection)
Computes the CoverageQueryResult for each of the grid points. Call this method after setting up the Grid and adding the desired Assets to the definition.
Public methodComputeCoverageOverTheGrid(JulianDate, JulianDate)
Computes the CoverageQueryResult for each of the grid points. Call this method after setting up the Grid and adding the desired Assets to the definition.
Public methodComputeCoverageOverTheGrid(TimeIntervalCollection, ITrackCalculationProgress)
Computes the CoverageQueryResult for each of the grid points. Call this method after setting up the Grid and adding the desired Assets to the definition.
Public methodComputeCoverageOverTheGrid(JulianDate, JulianDate, ITrackCalculationProgress)
Computes the CoverageQueryResult for each of the grid points. Call this method after setting up the Grid and adding the desired Assets to the definition.
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 DefinitionalObjectComputeCurrentDefinitionHashCode.)
Public methodCreateGridPointForAccess
This method is used as the default behavior for GridPointCreationMethod. The following services are provided: ILocationPointService, IOrientationAxesService, IKinematicStateService. The location is set as a PointCartographic based on Position and the CentralBody property. The orientation is AxesEastNorthUp by default, so that any FieldOfViewExtensions added to the default platform will be pointing up by default.
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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
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.)
Public methodRemoveAllAssets
Remove all assets from the coverage definition.
Public methodRemoveAsset(Object)
Removes the specified asset from the list of assets.
Public methodRemoveAsset(AssetDefinition)
Removes the specified asset definition from the list of assets.
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
Remarks
See the Coverage topic for more detail on how to use this class.
See Also