cvrProgressReporter.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   cvrProgressReporter.h
 *         Contains the class cvr::progressReporter. All classes that
 *         want to report progress via a progressInfo object should
 *         derive from this class.
 * \author Peter Doerfler
 * \date   30.03.2005
 *
 * $Id: cvrProgressReporter.h,v 1.4 2007/10/07 04:20:59 alvarado Exp $
 */

#ifndef _CVR_PROGRESS_REPORTER_H_
#define _CVR_PROGRESS_REPORTER_H_


namespace cvr  {
  class progressInfo;

  /**
   * Interface for all objects that provide progressInfo interface.
   *
   * \ingroup gInterfaces
   */
  class progressReporter {
  public:

    /**
     * Default destructor
     */
    progressReporter();

    /**
     * Copy destructor
     */
    progressReporter(const progressReporter& other);

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

    /**
     * Copy the \a other progressReporter
     */
    progressReporter& copy(const progressReporter& other);

    /**
     * Copy the \a other progressReporter
     */
    progressReporter& operator=(const progressReporter& other);

    /**
     * Return a pointer to a clone of this progressReporter
     */
    progressReporter* clone() const;

    /**
     * Return a pointer to a new instance of this progressReporter
     */
    progressReporter* newInstance() const;

    /**
     * Set the progressInfo %object to be used.
     *
     * A clone of the given %object will be generated.
     */
    void setProgressObject(const progressInfo& progress);

    /**
     * Remove the active progressInfo %object.
     */
    void removeProgressObject();

    /**
     * Return true if a valid progressInfo %object has already been set.
     */
    bool haveValidProgressObject() const;

    /**
     * Return true if a valid progressInfo %object has already been set, and if
     * its detail level is greater or equal the given value.
     */
    bool haveValidProgressObject(const int detailLevel) const;

    /**
     * Get a read-only reference to the progressInfo %object
     */
    const progressInfo& getProgressObject() const;

    /**
     * Get a modifiable reference to the progressInfo %object
     */
    progressInfo& getProgressObject();

  protected:

    /**
     * The current progressInfo %object.
     */
    progressInfo* progressObject_;
  };


} //namespace cvr

#endif