agi.foundation.numericalmethods.advanced

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

Class TimeIntervalFinderProgress

java.lang.Object

agi.foundation.numericalmethods.advanced.TimeIntervalFinderProgress

public class TimeIntervalFinderProgress
extends Object

Contains additional information reported to ITrackCalculationProgress.reportProgress(int, java.lang.Object) by TimeIntervalFinder (get).

Constructor Summary

Constructors

Constructor and Description
TimeIntervalFinderProgress(TimeIntervalFinder timeIntervalFinder, JulianDate startDate, JulianDate endDate, Duration complete) Initializes a new instance with the specified parameters.

Method Summary

Modifier and Type	Method and Description
Duration	getDurationComplete() Gets the quantity of time that has already been computed.
JulianDate	getEndDate() Gets the last date to be evaluated.
int	getPercentComplete() Gets an estimate of the percentage of work that has been completed.
JulianDate	getStartDate() Gets the first date to be evaluated.
TimeIntervalFinder	getTimeIntervalFinder() Gets the time interval finder that is reporting progress.
Duration	getTotalDuration() Gets the quantity of time to be evaluated.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeIntervalFinderProgress

public TimeIntervalFinderProgress(TimeIntervalFinder timeIntervalFinder,
                                  @Nonnull
                                  JulianDate startDate,
                                  @Nonnull
                                  JulianDate endDate,
                                  @Nonnull
                                  Duration complete)

Initializes a new instance with the specified parameters.

Parameters:

timeIntervalFinder - The time interval finder that is reporting progress.

startDate - The first date to be evaluated.

endDate - The last date to be evaluated.

complete - The quantity of time for which the computation has been completed.

Method Detail

getTimeIntervalFinder

public final TimeIntervalFinder getTimeIntervalFinder()

Gets the time interval finder that is reporting progress.

getStartDate

@Nonnull
public final JulianDate getStartDate()

Gets the first date to be evaluated.

getEndDate

@Nonnull
public final JulianDate getEndDate()

Gets the last date to be evaluated.

getTotalDuration

@Nonnull
public final Duration getTotalDuration()

Gets the quantity of time to be evaluated.

getDurationComplete

@Nonnull
public final Duration getDurationComplete()

Gets the quantity of time that has already been computed.

getPercentComplete

public final int getPercentComplete()

Gets an estimate of the percentage of work that has been completed.