com.idevicesinc.sweetblue.utils

Class TimeEstimator

java.lang.Object

com.idevicesinc.sweetblue.utils.TimeEstimator

public class TimeEstimator
extends java.lang.Object

A zero-dependency utility class to track running average time of operations and estimate the completion time of long running operations like firmware updates. Basically takes times as doubles representing seconds, and spits back the same.

Constructor Summary

Constructors

Constructor and Description
TimeEstimator(int runningAverageN) Lets this class act as a utility for calculating the running average completion time of arbitrary operations.
TimeEstimator(int totalSteps, double estimatedTimePerStep, int runningAverageN) Lets this class act as a "time remaining" estimator for long-running operations.

Method Summary

Modifier and Type	Method and Description
void	addTime(double timeStep) Adds the time it took for a just-completed operation to finish and updates the running average time.
double	getRunningAverage()
int	getRunningAverageN()
int	getStepsCompleted()
int	getStepsRemaining()
double	getTimeElapsed()
double	getTimeRemaining()
double	getTotalAverage()

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeEstimator

public TimeEstimator(int totalSteps,
                     double estimatedTimePerStep,
                     int runningAverageN)

Lets this class act as a "time remaining" estimator for long-running operations.

TimeEstimator

public TimeEstimator(int runningAverageN)

Lets this class act as a utility for calculating the running average completion time of arbitrary operations.

Method Detail

addTime

public void addTime(double timeStep)

Adds the time it took for a just-completed operation to finish and updates the running average time.

getTimeElapsed

public double getTimeElapsed()

getTimeRemaining

public double getTimeRemaining()

getStepsCompleted

public int getStepsCompleted()

getStepsRemaining

public int getStepsRemaining()

getRunningAverage

public double getRunningAverage()

getRunningAverageN

public int getRunningAverageN()

getTotalAverage

public double getTotalAverage()