cvrException.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   cvrException.h
 *         Defines base class for all exceptions in the CVR-Lib.
 *         If you compile the library with the symbol _DEBUG_EXCEPTION defined
 *         the process of creating an exception will print an error message
 *         in std::cerr.  This should help you finding problems with systems
 *         that cannot cope with C++ exception (e.g. Java).
 * \author Pablo Alvarado
 * \date   07.04.99
 *
 * $Id: cvrException.h,v 1.5 2007/04/04 19:18:29 alvarado Exp $
 */

#ifndef _CVR_EXCEPTION_H
#define _CVR_EXCEPTION_H

#include "cvrObject.h"
#include <exception>
#include <string>

namespace cvr {
  /**
   * Base class for all CVR-Libexceptions
   */
  class exception : public object,public std::exception {
    public:
    /**
     * Constructor with an optional string.
     * @param excName name of the exception.  These string will be copied and
     *                can be accessed with the "what()" method
     */
    exception(const char* excName = "exception");

    /**
     * Constructor with an optional string.
     * @param excName name of the exception.  These string will be copied and
     *                can be accessed with the "what()" method
     */
    exception(const std::string& excName);

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

    /**
     * Destructor
     */
    virtual ~exception() throw ();

    /**
     * Returns the name of this type
     */
    virtual const std::string& name() const;

    /**
     * Exception string
     *
     * @return The internal string with the information set at construction
     *         time.
     */
    virtual const char* what() const throw ();

    /**
     * Copy member
     */
    exception& copy(const exception& other);

    /**
     * Clone this object
     */
    virtual exception* clone() const;

    /**
     * Create new instance of this object
     */
    virtual exception* newInstance() const;

    /**
     * Alias for copy operator
     */
    exception& operator=(const exception& other);

  protected:
    /**
     * The exception message.
     *
     * This string will be returned with the method what() and is set at
     * construction time.
     */
    std::string exceptionName_;
  };

}

#endif