edu.mines.jtk.util.PartialMonitor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of edu-mines-jtk Show documentation

Java packages for science and engineering

There is a newer version: 1.1.0

/****************************************************************************
Copyright 2003, Landmark Graphics and others.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
 ****************************************************************************/
package edu.mines.jtk.util;

/**
 * Wrap an existing Monitor with a partial range.
 * Note that only makes sense to call initReport()
 * with the first wrapper used.
 *
 * @author W.S. Harlan
 */
public class PartialMonitor implements Monitor {
    private Monitor _wrapped = null;
    private double _begin = 0.0;
    private double _end = 1.0;

    /**
     * An existing Monitor will be wrapped for progress in a limited range.
     *
     * @param wrapped The wrapped monitor.
     * @param begin   The first value to be updated to the wrapped monitor,
     *                corresponding to a 0 reported to this monitor.
     * @param end     The last value to be updated to the wrapped monitor
     *                corresponding to a 1 reported to this monitor.
     */
    public PartialMonitor(final Monitor wrapped, final double begin, final double end) {
        _wrapped = wrapped;
        _begin = begin;
        _end = end;
    }

    @Override
    public void report(final double fraction) {
        if (_wrapped == null) {
            return;
        }
        _wrapped.report(fraction * (_end - _begin) + _begin);
    }

    @Override
    public boolean isCanceled() {
        return _wrapped.isCanceled();
    }

    @Override
    public void initReport(final double initFraction) {
        _wrapped.initReport(initFraction * (_end - _begin) + _begin);
    }
}