001/*******************************************************************************
002 * This software is provided as a supplement to the authors' textbooks on digital
003 * image processing published by Springer-Verlag in various languages and editions.
004 * Permission to use and distribute this software is granted under the BSD 2-Clause
005 * "Simplified" License (see http://opensource.org/licenses/BSD-2-Clause).
006 * Copyright (c) 2006-2023 Wilhelm Burger, Mark J. Burge. All rights reserved.
007 * Visit https://imagingbook.com for additional details.
008 ******************************************************************************/
009package imagingbook.common.util.progress;
010
011import imagingbook.common.filter.generic.GenericFilter;
012
013/**
014 * Interface for defining tasks that may be queried (monitored) to report their current progress status. Monitored
015 * objects (tasks) must only implement method {@link #getProgress()}, which returns the current completion status. See
016 * {@link GenericFilter} for an example.
017 *
018 * @see ProgressMonitor
019 */
020public interface ProgressReporter {
021
022        /**
023         * Returns a value in [0,1) indicating to which degree this task is complete.
024         *
025         * @return a value between 0 and 1
026         */
027        public double getProgress();
028
029}