src/error.h

   1 ///
   2 /// \file       error.h
   3 ///             Common exception classes for the Barry library
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2006, Net Direct Inc. (http://www.netdirect.ca/)
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  17
  18     See the GNU General Public License in the COPYING file at the
  19     root directory of this project for more details.
  20 */
  21
  22 #ifndef __BARRY_ERROR_H__
  23 #define __BARRY_ERROR_H__
  24
  25 #include <stdexcept>
  26
  27 namespace Barry {
  28
  29 /// \addtogroup exceptions
  30 /// @{
  31
  32 //
  33 // BError class
  34 //
  35 /// Currently the only Barry exception class, and planned to be the base class
  36 /// for any future derived exceptions.  Thrown on any protocol error.
  37 ///
  38 class BError : public std::runtime_error
  39 {
  40 public:
  41         BError(const std::string &str) : std::runtime_error(str) {}
  42         BError(int libusb_errno, const std::string &str);
  43 };
  44
  45 /// @}
  46
  47 } // namespace Barry
  48
  49 #endif
  50