agi.foundation.coverage.figureofmerit

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

Class ResponseTime

java.lang.Object

agi.foundation.coverage.figureofmerit.ResponseTime

public final class ResponseTime
extends Object

A figure of merit which provides statistical information regarding the time it takes to gain coverage from a point in time where there is no coverage.

Method Summary

Modifier and Type	Method and Description
static double	instantaneousResponseTime(CoverageQueryResult coverageIntervals, JulianDate time) Given a point in time, this computes the time it takes to gain coverage (in seconds).
static double	maximumResponseTime(CoverageQueryResult coverageIntervals) Computes the maximum time it takes to gain coverage.
static double	minimumResponseTime(CoverageQueryResult coverageIntervals) The minimum time it takes to gain coverage.

Methods inherited from class java.lang.Object

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

Method Detail

minimumResponseTime

public static double minimumResponseTime(@Nonnull
                                         CoverageQueryResult coverageIntervals)

The minimum time it takes to gain coverage.

If any coverage exists, this is zero. Otherwise, it is the length of the interval of interest.

Parameters:

coverageIntervals - The intervals of coverage.

Returns:

The minimum time it takes to regain coverage at any point in the overall interval.

maximumResponseTime

public static double maximumResponseTime(@Nonnull
                                         CoverageQueryResult coverageIntervals)

Computes the maximum time it takes to gain coverage.

This is the same as RevisitTime.maximumRevisitTime(CoverageQueryResult).

Parameters:

coverageIntervals - The intervals of coverage.

Returns:

The maximum time it takes to regain coverage at any point in the overall interval.

instantaneousResponseTime

public static double instantaneousResponseTime(@Nonnull
                                               CoverageQueryResult coverageIntervals,
                                               @Nonnull
                                               JulianDate time)

Given a point in time, this computes the time it takes to gain coverage (in seconds).

Parameters:

coverageIntervals - The intervals of coverage.

time - The time of interest.

Returns:

The time in between the specified time and the next available coverage interval.

Throws:

IllegalStateException - Thrown if the time lies outside of the ConsideredIntervals (get / set) or within the UnknownIntervals (get / set).