public class CommandLineProgressReporter extends Object implements ProgressReporter
Modifier and Type | Field and Description |
---|---|
static double |
DEFAULT_PROGRESS_REPORT_STEP_SIZE |
Constructor and Description |
---|
CommandLineProgressReporter() |
Modifier and Type | Method and Description |
---|---|
double |
getProgressReportStepSize()
Returns the percent of computation that have to be completed until a new
notification is written to the command line.
|
int |
getSteps()
Returns the number of steps that already have been completed.
|
int |
getTotalSteps()
Returns the total number of steps that are necessary to complete the
overall task.
|
void |
incrementSteps()
Notes that one additional step has been completed.
|
void |
resetSteps()
Resets the number of completed steps to zero.
|
void |
setProgressReportStepSize(double progressReportStepSize)
Sets the percent of computation that have to be completed until a new
notification is written to the command line.
|
void |
setTotalSteps(int totalSteps)
Sets the total number of steps that are necessary to complete the overall
task.
|
public static final double DEFAULT_PROGRESS_REPORT_STEP_SIZE
public void setTotalSteps(int totalSteps)
setTotalSteps
in interface ProgressReporter
totalSteps
- the total number of steps that are necessary to
complete the overall task.public int getTotalSteps()
getTotalSteps
in interface ProgressReporter
public double getProgressReportStepSize()
public void setProgressReportStepSize(double progressReportStepSize)
progressReportStepSize
- the percent of computation that have to be
completed until a new notification is written to the command line.public void incrementSteps()
ProgressReporter
incrementSteps
in interface ProgressReporter
public int getSteps()
getSteps
in interface ProgressReporter
public void resetSteps()
resetSteps
in interface ProgressReporter
Copyright (C) 2013-2015 Benjamin Paaßen, Georg Zentgraf, AG Theoretical Computer Science, Centre of Excellence Cognitive Interaction Technology (CITEC), University of Bielefeld, licensed under the AGPL v. 3: http://openresearch.cit-ec.de/projects/tcs . This documentation is licensed under the conditions of CC-BY-SA 4.0: https://creativecommons.org/licenses/by-sa/4.0/