public abstract class CoverageData extends Object
For more information, see the documentation overview on Coverage.
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.
|
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.
|
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 ). |
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 time 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 or
not the query is satisfied because insufficient information is available.
|
protected void |
setConsideredIntervals(TimeIntervalCollection value)
Sets the time 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 or
not the query is satisfied because insufficient information is available.
|
public static final IServiceProvider GridPointPlaceholder
protected CoverageData()
protected CoverageData(@Nonnull CoverageData existingInstance)
existingInstance
- The existing instance to copy.ArgumentNullException
- Thrown when existingInstance
is null
.protected final void setCoverageData(TimeIntervalCollection considered, TimeIntervalCollection satisfied, TimeIntervalCollection unknown, List<Object> assets, List<AccessQueryResult> assetResults)
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
.@Nonnull public final TimeIntervalCollection getSatisfactionForAsset(Object 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)
.
asset
- The asset providing coverage.ArgumentException
- The specified asset
does not exist in this CoverageData
.public final TimeIntervalCollection getConsideredIntervals()
protected final void setConsideredIntervals(TimeIntervalCollection value)
@Nonnull public final ArrayList<Object> getAssetsSatisfiedAtTime(@Nonnull JulianDate time)
time
- The time to check for coverage.@Nonnull public final ArrayList<Object> getAssetsUnknownAtTime(@Nonnull JulianDate time)
time
- The time to check for unknown data.public final AccessQueryResult getAccessResultsForAsset(Object asset)
asset
- The asset for which to search.ArgumentException
- The specified asset
does not exist in this CoverageData
.public final TimeIntervalCollection getSatisfactionIntervals()
protected final void setSatisfactionIntervals(TimeIntervalCollection value)
public final TimeIntervalCollection getUnknownIntervals()
protected final void setUnknownIntervals(TimeIntervalCollection value)
protected final List<Object> getAssetsConsidered()
protected final List<AccessQueryResult> getAssetAccessResults()
AssetsConsidered
(get
).