agi.foundation.infrastructure

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

Class AverageSubCalculationProgress

java.lang.Object

agi.foundation.infrastructure.AverageSubCalculationProgress

public class AverageSubCalculationProgress
extends Object

An implementation of ITrackCalculationProgress that averages the progress of a number of sub-calculations and reports the result to another ITrackCalculationProgress instance. The return value of AverageSubCalculationProgress.forSubCalculation(double) should be passed to each sub-calculation.

Constructor Summary

Constructors

Constructor and Description
AverageSubCalculationProgress(ITrackCalculationProgress parentProgress) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
ITrackCalculationProgress	forSubCalculation(double weight) Gets an ITrackCalculationProgress instance for a sub-calculation.
boolean	getCancellationPending() Gets a value indicating whether cancellation of the calculation is requested.
int	getLastProgress() Gets the last value of the overall progress, averaged over the sub-calculations.
int[]	getSubCalculationProgress() Gets the set of progress values, each representing the progress of a sub-calculation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AverageSubCalculationProgress

public AverageSubCalculationProgress(@Nullable
                                     ITrackCalculationProgress parentProgress)

Initializes a new instance.

Parameters:

parentProgress - The parent instance to which to report progress.

Method Detail

forSubCalculation

@Nonnull
public final ITrackCalculationProgress forSubCalculation(double weight)

Gets an ITrackCalculationProgress instance for a sub-calculation.

Parameters:

weight - The weight of this sub-calculation relative to other sub-calculations.

Returns:

The progress instance to pass to a sub-calculation.

getCancellationPending

public final boolean getCancellationPending()

Gets a value indicating whether cancellation of the calculation is requested. If this returns true, the calculation will stop as soon as possible.

This method will not necessarily be called in the same thread that initiated the calculation, nor is it guaranteed to be called in the same thread each time it is called. However, a single calculation will not call this method in multiple threads simultaneously.

getLastProgress

public final int getLastProgress()

Gets the last value of the overall progress, averaged over the sub-calculations.

getSubCalculationProgress

@Nonnull
public final int[] getSubCalculationProgress()

Gets the set of progress values, each representing the progress of a sub-calculation.

Returns:

The progress values.