agi.foundation.coverage

(agi.foundation.models-2024r3.jar)

Class CoverageData

java.lang.Object

agi.foundation.coverage.CoverageData

Direct Known Subclasses:

CoverageQueryResult

public abstract class CoverageData
extends Object

Contains all the information generated by a coverage calculation for a single point. Coverage data for a given point represents the set of assets which have access to the point at any given time.

For more information, see the documentation overview on Coverage.

Field Summary

Fields

Modifier and Type	Field and Description
static IServiceProvider	GridPointPlaceholder Gets an object that can be used as a placeholder to be replaced by grid points during a coverage calculation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CoverageData() Initializes a new instance.
protected	CoverageData(CoverageData existingInstance) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
AccessQueryResult	getAccessResultsForAsset(Object asset) Get a set of access intervals from the given asset.
protected List<AccessQueryResult>	getAssetAccessResults() Gets a list of the access results corresponding to each of the asset objects in AssetsConsidered (get / set).
protected List<Object>	getAssetsConsidered() Gets a list of the considered assets.
ArrayList<Object>	getAssetsSatisfiedAtTime(JulianDate time) Gets a list of the assets providing coverage at the given time.
ArrayList<Object>	getAssetsUnknownAtTime(JulianDate time) Gets a list of the assets which do not have enough information to determine coverage at the given time.
TimeIntervalCollection	getConsideredIntervals() Gets the intervals considered when computing these coverage results.
TimeIntervalCollection	getSatisfactionForAsset(Object asset) Get the intervals where both access and coverage exist for the given asset.
TimeIntervalCollection	getSatisfactionIntervals() Gets the intervals during which coverage is satisfied.
TimeIntervalCollection	getUnknownIntervals() Gets the intervals during which it is unknown whether the query is satisfied because insufficient information is available.
protected void	setAssetAccessResults(List<AccessQueryResult> value) Sets a list of the access results corresponding to each of the asset objects in AssetsConsidered (get / set).
protected void	setAssetsConsidered(List<Object> value) Sets a list of the considered assets.
protected void	setConsideredIntervals(TimeIntervalCollection value) Sets the intervals considered when computing these coverage results.
protected void	setCoverageData(TimeIntervalCollection considered, TimeIntervalCollection satisfied, TimeIntervalCollection unknown, List<Object> assets, List<AccessQueryResult> assetResults) Sets the coverage data.
protected void	setSatisfactionIntervals(TimeIntervalCollection value) Sets the intervals during which coverage is satisfied.
protected void	setUnknownIntervals(TimeIntervalCollection value) Sets the intervals during which it is unknown whether the query is satisfied because insufficient information is available.

Methods inherited from class java.lang.Object

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

Field Detail

GridPointPlaceholder

@Nonnull
public static final IServiceProvider GridPointPlaceholder

Gets an object that can be used as a placeholder to be replaced by grid points during a coverage calculation.

Constructor Detail

CoverageData

protected CoverageData()

Initializes a new instance.

CoverageData

protected CoverageData(@Nonnull
                       CoverageData existingInstance)

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

Parameters:

existingInstance - The existing instance to copy.

Throws:

ArgumentNullException - Thrown when existingInstance is null.

Method Detail

getConsideredIntervals

@Nonnull
public final TimeIntervalCollection getConsideredIntervals()

Gets the intervals considered when computing these coverage results.

setConsideredIntervals

protected final void setConsideredIntervals(@Nonnull
                                            TimeIntervalCollection value)

Sets the intervals considered when computing these coverage results.

getSatisfactionIntervals

@Nonnull
public final TimeIntervalCollection getSatisfactionIntervals()

Gets the intervals during which coverage is satisfied.

setSatisfactionIntervals

protected final void setSatisfactionIntervals(@Nonnull
                                              TimeIntervalCollection value)

Sets the intervals during which coverage is satisfied.

getUnknownIntervals

@Nonnull
public final TimeIntervalCollection getUnknownIntervals()

Gets the intervals during which it is unknown whether the query is satisfied because insufficient information is available.

setUnknownIntervals

protected final void setUnknownIntervals(@Nonnull
                                         TimeIntervalCollection value)

Sets the intervals during which it is unknown whether the query is satisfied because insufficient information is available.

getAssetsConsidered

@Nonnull
protected final List<Object> getAssetsConsidered()

Gets a list of the considered assets.

setAssetsConsidered

protected final void setAssetsConsidered(@Nonnull
                                         List<Object> value)

Sets a list of the considered assets.

getAssetAccessResults

@Nonnull
protected final List<AccessQueryResult> getAssetAccessResults()

Gets a list of the access results corresponding to each of the asset objects in AssetsConsidered (get / set).

setAssetAccessResults

protected final void setAssetAccessResults(@Nonnull
                                           List<AccessQueryResult> value)

Sets a list of the access results corresponding to each of the asset objects in AssetsConsidered (get / set).

setCoverageData

protected final void setCoverageData(@Nonnull
                                     TimeIntervalCollection considered,
                                     @Nonnull
                                     TimeIntervalCollection satisfied,
                                     @Nonnull
                                     TimeIntervalCollection unknown,
                                     @Nonnull
                                     List<Object> assets,
                                     @Nonnull
                                     List<AccessQueryResult> assetResults)

Sets the coverage data. This is used by derived classes when it's necessary to compute results during construction, prior to storing the data.

Parameters:

considered - The time intervals considered for the coverage analysis.

satisfied - The time intervals which have coverage.

unknown - The time intervals over which coverage cannot be determined.

assets - The list of asset objects which were considered when determining coverage.

assetResults - The list of access results corresponding to each asset in the list of assets.

getSatisfactionForAsset

@Nonnull
public final TimeIntervalCollection getSatisfactionForAsset(Object asset)

Get the intervals where both access and coverage exist for the given asset.

If certain other assets preclude the given asset from providing coverage despite its having access to the coverage target, the access intervals and the coverage satisfaction intervals may not coincide. To obtain the full access intervals, use CoverageData.getAccessResultsForAsset(java.lang.Object).

Parameters:

asset - The asset providing coverage.

Returns:

If the given asset provides satisfactory coverage, this returns the satisfaction intervals. If the given asset has access, but there is no coverage, it returns an empty collection.

Throws:

ArgumentException - The specified asset does not exist in this CoverageData.

getAssetsSatisfiedAtTime

@Nonnull
public final ArrayList<Object> getAssetsSatisfiedAtTime(@Nonnull
                                                                  JulianDate time)

Gets a list of the assets providing coverage at the given time.

Parameters:

time - The time to check for coverage.

Returns:

A list of the assets providing coverage at the given time.

getAssetsUnknownAtTime

@Nonnull
public final ArrayList<Object> getAssetsUnknownAtTime(@Nonnull
                                                                JulianDate time)

Gets a list of the assets which do not have enough information to determine coverage at the given time.

Parameters:

time - The time to check for unknown data.

Returns:

A list of the assets whose coverage data is indeterminate at the given time.

getAccessResultsForAsset

public final AccessQueryResult getAccessResultsForAsset(Object asset)

Get a set of access intervals from the given asset.

Parameters:

asset - The asset for which to search.

Returns:

If the asset is present in the data, this returns its access results (which may be empty).

Throws:

ArgumentException - The specified asset does not exist in this CoverageData.