agi.foundation.coverage

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

Class CoverageFilter

java.lang.Object

agi.foundation.coverage.CoverageFilter

public class CoverageFilter
extends Object

Filters coverage results based on the number of available assets.

Constructor Summary

Constructors

Constructor and Description
CoverageFilter() Initializes a new instance configured to filter based on 'at least' one asset.
CoverageFilter(CoverageFilterType filterType, int numberOfAssets) Initializes a new instance with a specified filter type and number of assets.

Method Summary

Modifier and Type	Method and Description
TimeIntervalCollection1<Integer>	constrainIntervals(TimeIntervalCollection1<Integer> coverageIntervals) Constrains a set of time intervals based on the number of assets indicated by the data of the interval collection.
CoverageFilterType	getFilterType() Gets a value indicating how the number of assets are used to filter a given interval of access.
int	getNumberOfAssets() Gets the number of assets required to satisfy this constraint.
AccessQuery	getQuery(AccessQuery... queries) Constrains a set of access queries into one based on the given FilterType (get).
boolean	isIntervalValid(TimeInterval1<Integer> interval) Checks whether the given interval satisfied the constraint.

Methods inherited from class java.lang.Object

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

Constructor Detail

CoverageFilter

public CoverageFilter()

Initializes a new instance configured to filter based on 'at least' one asset.

CoverageFilter

public CoverageFilter(@Nonnull
                      CoverageFilterType filterType,
                      int numberOfAssets)

Initializes a new instance with a specified filter type and number of assets.

Parameters:

filterType - The type indicating how to filter the number of assets.

numberOfAssets - The number of assets required to provide coverage.

Method Detail

getNumberOfAssets

public final int getNumberOfAssets()

Gets the number of assets required to satisfy this constraint. The operation performed based on the number of assets depends upon the CoverageFilterType of the filter.

getFilterType

@Nonnull
public final CoverageFilterType getFilterType()

Gets a value indicating how the number of assets are used to filter a given interval of access.

isIntervalValid

public boolean isIntervalValid(@Nonnull
                               TimeInterval1<Integer> interval)

Checks whether the given interval satisfied the constraint.

Parameters:

interval - The interval with the number of assets available in its Data (get) property.

Returns:

Returns true if the constraint is satisfied.

constrainIntervals

@Nonnull
public TimeIntervalCollection1<Integer> constrainIntervals(@Nonnull
                                                                     TimeIntervalCollection1<Integer> coverageIntervals)

Constrains a set of time intervals based on the number of assets indicated by the data of the interval collection.

Parameters:

coverageIntervals - The time intervals representing coverage.

Returns:

The time intervals which satisfy this constraint.

getQuery

@Nonnull
public final AccessQuery getQuery(@Nonnull
                                            AccessQuery... queries)

Constrains a set of access queries into one based on the given FilterType (get).

Parameters:

queries - The set of queries to constrain.

Returns:

A single query representing the result of constraining the given set of queries.