agi.foundation.coverage

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

Class CoverageQueryResult

java.lang.Object

agi.foundation.coverage.CoverageData

agi.foundation.coverage.CoverageQueryResult

public class CoverageQueryResult
extends CoverageData

Contains all the information generated by a coverage calculation for a single grid point.

Field Summary

Fields inherited from class agi.foundation.coverage.CoverageData

GridPointPlaceholder

Constructor Summary

Constructors

Constructor and Description
CoverageQueryResult(TimeIntervalCollection considered) Initializes a new instance based on the given intervals of consideration.
CoverageQueryResult(TimeIntervalCollection considered, AccessQueryResult satisfactionResult) Initializes a new instance based on an existing AccessQueryResult and a set of intervals considered in the coverage calculation producing these results.
CoverageQueryResult(TimeIntervalCollection considered, CoverageFilter filter, List<Object> assets, List<AccessQueryResult> assetResults) Initializes a new instance based on a set of assets and their corresponding AccessQueryResults.

Method Summary

Modifier and Type	Method and Description
CoverageQueryResult	applyFilter(CoverageFilter filter) Applies the given filter to this result and returns a new result.
List<CoverageFilter>	getAppliedCoverageFilters() Gets the set of CoverageFilters which have been applied to these results.
TimeIntervalCollection1<Integer>	getSatisfactionIntervalsWithNumberOfAssets() Gets the set of overall satisfaction intervals with the number of assets providing coverage for that interval recorded in the Data (get) property.

Methods inherited from class agi.foundation.coverage.CoverageData

getAccessResultsForAsset, getAssetAccessResults, getAssetsConsidered, getAssetsSatisfiedAtTime, getAssetsUnknownAtTime, getConsideredIntervals, getSatisfactionForAsset, getSatisfactionIntervals, getUnknownIntervals, setAssetAccessResults, setAssetsConsidered, setConsideredIntervals, setCoverageData, setSatisfactionIntervals, setUnknownIntervals

Methods inherited from class java.lang.Object

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

Constructor Detail

CoverageQueryResult

public CoverageQueryResult(@Nonnull
                           TimeIntervalCollection considered)

Initializes a new instance based on the given intervals of consideration.

Parameters:

considered - The intervals considered when calculating coverage.

CoverageQueryResult

public CoverageQueryResult(@Nonnull
                           TimeIntervalCollection considered,
                           @Nonnull
                           AccessQueryResult satisfactionResult)

Initializes a new instance based on an existing AccessQueryResult and a set of intervals considered in the coverage calculation producing these results.

Parameters:

considered - The intervals considered in the coverage calculation.

satisfactionResult - The existing result of the overall calculation.

CoverageQueryResult

public CoverageQueryResult(@Nonnull
                           TimeIntervalCollection considered,
                           @Nonnull
                           CoverageFilter filter,
                           @Nonnull
                           List<Object> assets,
                           @Nonnull
                           List<AccessQueryResult> assetResults)

Initializes a new instance based on a set of assets and their corresponding AccessQueryResults.

Parameters:

considered - The intervals considered in the coverage calculation.

filter - The filter used to indicate when coverage is satisfied.

assets - An ordered list of assets corresponding to assetResults.

assetResults - An ordered list of access results corresponding to the assets.

Method Detail

applyFilter

@Nonnull
public final CoverageQueryResult applyFilter(@Nonnull
                                                       CoverageFilter filter)

Applies the given filter to this result and returns a new result.

Parameters:

filter - The filter indicating whether any given interval satisfies coverage.

Returns:

The new result reflecting the given filter.

getSatisfactionIntervalsWithNumberOfAssets

@Nonnull
public final TimeIntervalCollection1<Integer> getSatisfactionIntervalsWithNumberOfAssets()

Gets the set of overall satisfaction intervals with the number of assets providing coverage for that interval recorded in the Data (get) property.

getAppliedCoverageFilters

@Nonnull
public final List<CoverageFilter> getAppliedCoverageFilters()

Gets the set of CoverageFilters which have been applied to these results.