Package org.moeaframework.algorithm.extension

Class ProgressExtension.ProgressEvent

java.lang.Object

org.moeaframework.algorithm.extension.ProgressExtension.ProgressEvent

Enclosing class:

ProgressExtension

public static class ProgressExtension.ProgressEvent
extends Object

A progress event, including the percent complete, elapsed time, and estimated remaining time.

Method Summary

Modifier and Type	Method	Description
Algorithm	getAlgorithm()	Returns the algorithm that is currently running.
Duration	getElapsedTime()	Returns the elapsed time.
double	getPercentComplete()	Returns the percent complete as a value between 0.0 and 100.0.
Duration	getRemainingTime()	Returns the estimated remaining time.
String	toString()
String	toString(int progressWidth)	Returns a string representation of this progress event including a progress bar.

Methods inherited from class java.lang.Object

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

Method Details

getAlgorithm

public Algorithm getAlgorithm()

Returns the algorithm that is currently running.

Returns:

the algorithm currently running

getPercentComplete

public double getPercentComplete()

Returns the percent complete as a value between 0.0 and 100.0.

Returns:

the percent complete as a fraction between 0.0 and 100.0

getElapsedTime

public Duration getElapsedTime()

Returns the elapsed time.

Returns:

the elapsed time

getRemainingTime

public Duration getRemainingTime()

Returns the estimated remaining time. A value of null indicates the remaining time could not be determined.

Returns:

the estimated remaining time or null

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(int progressWidth)

Returns a string representation of this progress event including a progress bar.

Parameters:

progressWidth - the width of the progress bar in characters

Returns:

the string representation