agi.foundation.numericalmethods.advanced

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

Class DurationFunctionExplorerProgress

java.lang.Object

agi.foundation.numericalmethods.advanced.DurationFunctionExplorerProgress

public class DurationFunctionExplorerProgress
extends Object

Contains additional information reported to ITrackCalculationProgress.reportProgress(int, java.lang.Object) by DurationFunctionExplorer.explore(Duration,Duration,ITrackCalculationProgress).

Constructor Summary

Constructors

Constructor and Description
DurationFunctionExplorerProgress(DurationFunctionExplorer explorer, Duration start, Duration stop, Duration complete, int percentComplete) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
Duration	getComplete() Gets the portion of the interval that has already been explored.
DurationFunctionExplorer	getExplorer() Gets the explorer instance that is reporting progress.
int	getPercentComplete() Gets the percentage of the interval that has already been explored.
Duration	getStart() Gets the beginning of the interval being explored.
Duration	getStop() Gets the end of the interval being explored.

Methods inherited from class java.lang.Object

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

Constructor Detail

DurationFunctionExplorerProgress

public DurationFunctionExplorerProgress(DurationFunctionExplorer explorer,
                                        @Nonnull
                                        Duration start,
                                        @Nonnull
                                        Duration stop,
                                        @Nonnull
                                        Duration complete,
                                        int percentComplete)

Initializes a new instance.

Parameters:

explorer - The explorer instance that is reporting progress.

start - The beginning of the interval being explored.

stop - The end of the interval being explored.

complete - The portion of the interval that has already been evaluated.

percentComplete - The percentage of the interval that has already been completed.

Method Detail

getExplorer

public final DurationFunctionExplorer getExplorer()

Gets the explorer instance that is reporting progress.

getStart

@Nonnull
public final Duration getStart()

Gets the beginning of the interval being explored.

getStop

@Nonnull
public final Duration getStop()

Gets the end of the interval being explored.

getComplete

@Nonnull
public final Duration getComplete()

Gets the portion of the interval that has already been explored.

getPercentComplete

public final int getPercentComplete()

Gets the percentage of the interval that has already been explored.