cvrInvalidParametersException.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   cvrInvalidParametersException.h
 *         Contains the class cvr::invalidParametersException, an exception
 *         thrown by classes derived from cvr::parametersManager::parameters
 * \author Pablo Alvarado
 * \date   06.01.2005
 *
 * $Id: cvrInvalidParametersException.h,v 1.1 2006/08/29 12:27:42 doerfler Exp $
 */

#ifndef _CVR_INVALID_PARAMETERS_EXCEPTION_H_
#define _CVR_INVALID_PARAMETERS_EXCEPTION_H_

#include "cvrException.h"

namespace cvr {

  /**
   * Exception thrown when the parameters are not set
   */
  class invalidParametersException : public exception {
  public:
    /**
     * Default constructor
     */
    invalidParametersException();

    /**
     * Constructor with the alternative object name, where the exception
     * was thrown
     *
     * @param str name of the class that throws the exception
     */
    invalidParametersException(const std::string& str);

    /**
     * Constructor with the alternative object name, where the exception
     * was thrown
     *
     * @param str name of the class that throws the exception
     */
    invalidParametersException(const char* str);

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

    /**
     * Returns a pointer to a clone of the parameters.
     */
    virtual invalidParametersException* clone() const;

    /**
     * Returns a pointer to a clone of the parameters.
     */
    virtual invalidParametersException* newInstance() const;
  };

}

#endif