ome.formats.importer.util

Class ProportionalTimeEstimatorImpl

java.lang.Object

ome.formats.importer.util.ProportionalTimeEstimatorImpl

All Implemented Interfaces:

TimeEstimator

public class ProportionalTimeEstimatorImpl
extends Object
implements TimeEstimator

Class implementing the TimeEstimator interface. Uses the Exponential Moving Average equation to provide an estimate of the remaining upload time of binary data. A correction factor is used for minimal overestimation.

Since:

5.0

Author:

Blazej Pindelski, bpindelski at dundee.ac.uk

Constructor Summary

Constructors

Constructor and Description
ProportionalTimeEstimatorImpl(long imageContainerSize) Creates a new object of this class with a defined internal buffer size.

Method Summary

Modifier and Type	Method and Description
long	getUploadTimeLeft() Return the estimated time left in milliseconds based on the calls to start and stop methods.
void	start() Starts the time counting.
void	stop() Stops the time counting and updates the internal time counter.
void	stop(long uploadedBytes) Stops the time counting and updates the internal updates the internal time counter and counter of total number of transmitted bytes.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProportionalTimeEstimatorImpl

public ProportionalTimeEstimatorImpl(long imageContainerSize)

Creates a new object of this class with a defined internal buffer size.

Parameters:

imageContainerSize - The total size in bytes of the data container for which upload time is being estimated.

Method Detail

start

public void start()

Description copied from interface: TimeEstimator

Starts the time counting.

Specified by:

start in interface TimeEstimator

See Also:

TimeEstimator.start()

stop

public void stop()

Description copied from interface: TimeEstimator

Stops the time counting and updates the internal time counter.

Specified by:

stop in interface TimeEstimator

See Also:

TimeEstimator.stop()

stop

public void stop(long uploadedBytes)

Description copied from interface: TimeEstimator

Stops the time counting and updates the internal updates the internal time counter and counter of total number of transmitted bytes.

Specified by:

stop in interface TimeEstimator

Parameters:

uploadedBytes - Number of bytes uploaded in a single time frame that is being sampled.

See Also:

TimeEstimator.stop(long)

getUploadTimeLeft

public long getUploadTimeLeft()

Description copied from interface: TimeEstimator

Return the estimated time left in milliseconds based on the calls to start and stop methods.

Specified by:

getUploadTimeLeft in interface TimeEstimator

Returns:

The estimated time remaining. The value 0 is returned if stop hasn't been called at least once before calling this method.

See Also:

TimeEstimator.getUploadTimeLeft()