MOEA Framework 2.12
API Specification

org.moeaframework.util.progress
Class ProgressEvent

java.lang.Object
  extended by org.moeaframework.util.progress.ProgressEvent
All Implemented Interfaces:
Serializable

public class ProgressEvent
extends Object
implements Serializable

A progress report, including the percent complete, elapsed time, and remaining time. These reports are generated by ProgressHelper.

See Also:
Serialized Form

Constructor Summary
ProgressEvent(Executor executor, int currentSeed, int totalSeeds, boolean isSeedFinished, int currentNFE, int maxNFE, double percentComplete, double elapsedTime, double remainingTime, double maxTime)
          Constructs a new progress report with the given values.
 
Method Summary
 int getCurrentNFE()
          Returns the current number of objective function evaluations for the current seed.
 int getCurrentSeed()
          Returns the current seed being evaluated, starting at 1.
 double getElapsedTime()
          Returns the elapsed time in seconds.
 Executor getExecutor()
          Returns the executor from which these progress reports originate.
 int getMaxNFE()
          Returns the maximum number of objective function evaluations per seed, or -1 if not set.
 double getMaxTime()
          Returns the maximum elapsed time per seed, or -1 if not set.
 double getPercentComplete()
          Returns the percent complete as a fraction between 0 and 1.
 double getRemainingTime()
          Returns the estimated remaining time in seconds.
 int getTotalSeeds()
          Returns the total number of seeds to be evaluated.
 boolean isSeedFinished()
          Returns true if this event was created in response to a seed finishing; false otherwise.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProgressEvent

public ProgressEvent(Executor executor,
                     int currentSeed,
                     int totalSeeds,
                     boolean isSeedFinished,
                     int currentNFE,
                     int maxNFE,
                     double percentComplete,
                     double elapsedTime,
                     double remainingTime,
                     double maxTime)
Constructs a new progress report with the given values.

Parameters:
executor - the executor from which these progress reports originate
currentSeed - the current seed being evaluated, starting at 1
totalSeeds - the total number of seeds to be evaluated
isSeedFinished - true if this event was created in response to a seed finishing; false otherwise
currentNFE - the current number of objective function evaluations for the current seed.
maxNFE - the maximum number of objective function evaluations per seed, or -1 if not set
percentComplete - the percent complete as a fraction between 0 and 1
elapsedTime - the elapsed time in seconds
remainingTime - the estimated remaining time in seconds
maxTime - the maximum elapsed time per seed in seconds, or -1 if not set
Method Detail

getExecutor

public Executor getExecutor()
Returns the executor from which these progress reports originate.

Returns:
the executor from which these progress reports originate

getCurrentSeed

public int getCurrentSeed()
Returns the current seed being evaluated, starting at 1.

Returns:
the current seed being evaluated, starting at 1

getTotalSeeds

public int getTotalSeeds()
Returns the total number of seeds to be evaluated.

Returns:
the total number of seeds to be evaluated

isSeedFinished

public boolean isSeedFinished()
Returns true if this event was created in response to a seed finishing; false otherwise. This indicates that new results are available in the executor.

Returns:
true if this event was created in response to a seed finishing; false otherwise

getCurrentNFE

public int getCurrentNFE()
Returns the current number of objective function evaluations for the current seed.

Returns:
the current number of objective function evaluations for the current seed

getMaxNFE

public int getMaxNFE()
Returns the maximum number of objective function evaluations per seed, or -1 if not set.

Returns:
the maximum number of objective function evaluations per seed

getPercentComplete

public double getPercentComplete()
Returns the percent complete as a fraction between 0 and 1.

Returns:
the percent complete as a fraction between 0 and 1

getElapsedTime

public double getElapsedTime()
Returns the elapsed time in seconds.

Returns:
the elapsed time in seconds

getRemainingTime

public double getRemainingTime()
Returns the estimated remaining time in seconds.

Returns:
the estimated remaining time in seconds

getMaxTime

public double getMaxTime()
Returns the maximum elapsed time per seed, or -1 if not set.

Returns:
the maximum elapsed time per seed

MOEA Framework 2.12
API Specification

Copyright 2009-2016 MOEA Framework. All rights reserved.
Licensed under the GNU Lesser General Public License.
Return to the MOEA Framework homepage. Visit us on Github!