cvrProgressInfo.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998 - 2005
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 *
 *
 * This file is part of the Computer Vision and Robotics Library (CVR-Lib)
 *
 * The CVR-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the BSD License.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the authors nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


/**
 * \file   cvrProgressInfo.h
 *         Contains the class progressInfo, base class for progress information
 * \author Pablo Alvarado
 * \author Peter Doerfler
 * \date   10.08.2000
 *
 * $Id: cvrProgressInfo.h,v 1.2 2005/07/22 15:59:17 doerfler Exp $
 */

#ifndef _CVR_PROGRESS_INFO_H_
#define _CVR_PROGRESS_INFO_H_

#include <string>

#include "cvrObject.h"

namespace cvr {

  /**
   * This class can be overloaded to display the training progress of
   * a process. It is mostly used for classifiers, where training can
   * take a long time.
   */
  class progressInfo : public object {
  public:
    /**
     * Default constructor.
     *
     * The default are empty title and 100 maximum steps. These are
     * rarely the correct settings. For informative progress
     * information set these values either with the constructor or the
     * setMaximumSteps() and setTitle() functions.
     *
     * @param title the name of the progressInfo object
     * @param maximumSteps the maximum number of steps of the process
     */
    progressInfo(const std::string& title = "",
                 const int maximumSteps = 100);

    /**
     * Copy constructor
     */
    progressInfo(const progressInfo& other);

    /**
     * Destructor
     */
    virtual ~progressInfo();

    /**
     * Set the title of the progress info block
     */
    virtual void setTitle(const std::string& theTitle);

    /**
     * Maximal number of steps
     */
    virtual void setMaxSteps(const int maximalSteps);

    /**
     * Detail level of substep information. Level 1 is equal to that
     * of normal steps.
     */
    virtual void setDetailLevel(const int level);

    /**
     * Return the used detail level of substep information
     */
    virtual int getDetailLevel() const;

    /**
     * Report one step done
     * @param progressInfo string with some text information for the step
     */
    virtual void step(const std::string& progressInfo)=0;

    /**
     * Report additional information for a step, with the given detail
     * level.
     *
     * The given information will be displayed only if the current detail level
     * is higher or equal than the detail specified in this method.
     *
     * @param detail is the detail level. The lowest (as in step()) is 1.
     * @param info the string displayed for the substep
     */
    virtual void substep(const int detail,
                         const std::string& info)=0;

    /**
     * Reset progress information
     */
    virtual void reset();

    /**
     * Returns true if someone wants the caller of this progress info
     * object to terminate. This function is mostly useful for GUI
     * progressInfo implementations.
     *
     * This default implementation always returns false.
     */
    virtual bool breakRequested() const;

    /**
     * The copy member
     */
    progressInfo& copy(const progressInfo& other);

    /**
     * Returns the name of the class.
     */
    const std::string& name() const;

    /**
     * The clone member
     */
    virtual progressInfo* clone() const=0;

    /**
     * The new instance member
     */
    virtual progressInfo* newInstance() const=0;

  protected:
    /**
     * Title for this progress info
     */
    std::string title_;

    /**
     * Maximum number of steps expected
     */
    int maxSteps_;

    /**
     * Detail level used for the substeps
     */
    int detailLevel_;

    /**
     * Last processed step
     */
    int lastStep_;

  };


}

#endif