Click or drag to resize

DiscreteCoverageDefinitionOnCentralBody Class

Note: This API is now obsolete.

Similar to CoverageDefinitionOnCentralBody, this class 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. For more information, see the Programmer's Guide-Overview-Analysis section of the documentation.

Instead of threading the calculation to loop over grid points, this coverage calculation will configure the grid to be evaluated in lock-step to take advantage of caching redundant calculations common among all grid points. The threads are then configured to loop over intervals of time at a given step size. The advantage of this approach is that it can significantly reduce the overall computation time in cases where Earth fixed-to-inertial frame calculations, communications network analysis, or other calculations largely independent of any particular grid point. The calculation can also be configured with a larger or smaller time step to trade off between overall run time and the resolution of the access calculations. If the step size is too small, CoverageDefinitionOnCentralBody may perform better by doing dynamic sampling over time rather than performing a large number of nearly-identical calculations. However, if the step size is too large, the discrete calculation may miss short intervals that are smaller than the step size.

Inheritance Hierarchy
SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.CoverageDiscreteCoverageDefinitionOnCentralBody

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 ParameterizedTemporallyPartitionedCoverageDefinition or MaterializedTemporallyPartitionedCoverageDefinition.")]
public class DiscreteCoverageDefinitionOnCentralBody : DefinitionalObject

The DiscreteCoverageDefinitionOnCentralBody 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 propertyFindAccessBetweenSteps
Gets or sets a flag indicating whether to perform additional access calculations between time steps where access was either gained or lost. If this is false, when a new step determines that access is now satisfied, the satisfied interval will begin at the time of that step.
Public propertyGrid
Gets or sets the scheme of the grid used to generate points of interest over which to analyze coverage.
Public propertyGridPoint
Gets a Point object that defines the location of any given grid point during the coverage computation. This point uses the parameterization system to dynamically change the location of the point when computing access over the grid. By defining Assets in relation to a GridPointPlatform based on this point, the access results recorded for each grid point will include the results of the access of the specified asset based on the location of that particular grid point.
Public propertyGridPointPlatform
Gets or sets the template for the analysis object located at any given grid point. This object also defines the location of the observer used to report access times. By default, this is a Platform located at the GridPoint with its orientation defined by an AxesEastNorthUp. So, any FieldOfViewExtensions added to the default platform will be pointing up by default.
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. Alternately, setting the number of available threads in the ThreadingPolicy will also control both whether coverage uses multiple threads and how many.

This is true by default. If true, the total time of the calculation will be divided into sub-intervals and distributed among threads.

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(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).)
Protected methodCheckForSameDefinition(DiscreteCoverageDefinitionOnCentralBody)
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).)
Public methodComputeCoverageOverTheGrid(JulianDate, JulianDate, Duration)
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, Duration, 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 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.
(Overrides DefinitionalObjectFreezeAggregatedObjects.)
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
See Also