org.hkijena.jipipe.api

Class JIPipeProgressInfoETA

java.lang.Object

org.hkijena.jipipe.api.JIPipeProgressInfoETA

public class JIPipeProgressInfoETA
extends Object

Allows to provide users with an ETA

Constructor Summary

Constructors

Constructor and Description
JIPipeProgressInfoETA()

Method Summary

Modifier and Type	Method and Description
int	getAverageWindow() Gets the window size for the ETA calculation
long	getLogInterval() Gets the log interval (milliseconds)
void	setAverageWindow(int averageWindow) Sets the window size for the ETA calculation
void	setLogInterval(long logInterval) Sets the log interval (milliseconds)
void	update(int currentIndex, int totalItems, JIPipeProgressInfo progressInfo) Updates the ETA and logs it if needed

Methods inherited from class java.lang.Object

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

Constructor Detail

JIPipeProgressInfoETA

public JIPipeProgressInfoETA()

Method Detail

getAverageWindow

public int getAverageWindow()

Gets the window size for the ETA calculation

Returns:

the window size

setAverageWindow

public void setAverageWindow(int averageWindow)

Sets the window size for the ETA calculation

Parameters:

averageWindow - the window size

getLogInterval

public long getLogInterval()

Gets the log interval (milliseconds)

Returns:

the log interval (milliseconds)

setLogInterval

public void setLogInterval(long logInterval)

Sets the log interval (milliseconds)

Parameters:

logInterval - the log interval (milliseconds)

update

public void update(int currentIndex,
                   int totalItems,
                   JIPipeProgressInfo progressInfo)

Updates the ETA and logs it if needed

Parameters:

currentIndex - the current index

totalItems - the total number of items

progressInfo - the progress info