cvrStatusMonitor.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998-2004
 * 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   cvrStatusMonitor.h
 *         Contains the parent class for all status monitors, which are
 *         objects that control what to do with error reports in functors,
 *         classifiers, viewers and ioHandlers.
 * \author Pablo Alvarado
 * \date   30.07.2004
 *
 * $Id: cvrStatusMonitor.h,v 1.4 2007/05/04 23:57:04 alvarado Exp $
 */

#ifndef _CVR_STATUS_MONITOR
#define _CVR_STATUS_MONITOR

#include "cvrObject.h"

namespace cvr {
  /**
   * Class statusMonitor
   *
   * Status monitors are objects that control what to do when an error is
   * reported:  should it just be ignored?  should it throw and exception?
   * should it be streamed out to std::cerr?
   *
   * You can call the global function cvr::setStatusMonitor() to set
   * the object for the whole library.
   *
   * This is an abstract class.
   */
  class statusMonitor : public object {
  public:
    /**
     * Default constructor
     */
    statusMonitor();

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

    /**
     * Return the name of this class
     */
    virtual const std::string& name() const = 0;

    /**
     * Return a static instance of the current object type, which is not
     * clonable since it has a singleton pattern.
     */
    virtual statusMonitor* clone() const = 0;

    /**
     * Return a static instance of the current object type
     */
    virtual statusMonitor* newInstance() const = 0;

    /**
     * Set a status string.
     *
     * @param id of the reporting class.  Usually you give here the output
     *        of name().
     * @param msg the const string to be reported.
     */
     virtual void set(const std::string& id,const char* msg) = 0;

    /**
     * Set a status string.
     *
     * @param id of the reporting class.  Usually you give here the output
     *        of name().
     * @param msg the const string to be reported.
     */
    virtual void set(const std::string& id,const std::string& msg) = 0;
  };

}

#endif