agi.foundation

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

Interface ITrackCalculationProgress

All Known Implementing Classes:

BackgroundCalculation

public interface ITrackCalculationProgress

An interface that is provided to a calculation method when you want to receive updates about the progress of the calculation and to have the ability to cancel it.

Method Summary

Modifier and Type	Method and Description
boolean	getCancellationPending() Gets a value indicating whether cancellation of the calculation is requested.
void	reportProgress(int percentProgress, Object additionalInformation) Called periodically by the calculation to indicate its progress.

Method Detail

reportProgress

void reportProgress(int percentProgress,
                    Object additionalInformation)

Called periodically by the calculation to indicate its progress.

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.

Parameters:

percentProgress - A value between 0 and 100 indicating the progress of the calculation. A value of -1 indicates that the percentage of the progress is unknown.

additionalInformation - Additional information about the progress of the calculation. The type of this object depends on the specific calculation.

getCancellationPending

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.