src/gdcmException.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmException.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/02/11 16:36:52 $
   7   Version:   $Revision: 1.22 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 #ifndef GDCM_EXCEPTION_H
  20 #define GDCM_EXCEPTION_H
  21
  22 #include "gdcmCommon.h"
  23
  24 #include <string>
  25 #include <iostream>
  26 #include <exception>
  27
  28 namespace gdcm
  29 {
  30
  31 //-----------------------------------------------------------------------------
  32 /**
  33  * \brief Any exception thrown in the gdcm library
  34  */
  35 class GDCM_EXPORT Exception : public std::exception
  36 {
  37 public:
  38    /*
  39     * \brief Builds an exception with minimal information: name of the thrower
  40     *        method and error message
  41     * @param from name of the thrower
  42     * @param error error description string
  43     */
  44    explicit Exception(const std::string &from, const std::string &error = "")
  45       throw();
  46
  47    /**
  48     * \brief virtual destructor makes this class dynamic
  49     */
  50    virtual ~Exception() throw() {};
  51
  52    /// exception caught within exception class: print error message and die
  53    static void fatal(const char *from) throw();
  54
  55    /// returns error message
  56    const std::string &getError() const throw() {
  57       return Error;
  58    }
  59
  60    /// try to discover this (dynamic) class name
  61    virtual std::string getName() const throw();
  62
  63    /// returns exception name string (overloads std::exception::what)
  64    virtual const char *what() const throw() {
  65       return (const char *) *this;
  66    }
  67
  68    /// returns exception name string
  69    operator const char *() const throw();
  70
  71    friend std::ostream &operator<<(std::ostream &os, const Exception &e);
  72
  73 protected:
  74    /// error message part 1
  75    std::string From;
  76    /// error message part 2
  77    std::string Error;
  78 };
  79
  80
  81 //-----------------------------------------------------------------------------
  82 /**
  83  * \brief File error exception thrown in the gdcm library
  84  */
  85 class GDCM_EXPORT FileError : public Exception
  86 {
  87 public:
  88    /**
  89     * \brief Builds an file-related exception with minimal information: name of
  90     *               the thrower method and error message
  91     * @param from name of the thrower
  92     * @param error error description string
  93     */
  94    explicit FileError(const std::string &from,
  95                           const std::string &error = "File error")
  96       throw() : Exception(from, error) { }
  97 };
  98
  99
 100 //-----------------------------------------------------------------------------
 101 /**
 102  * \brief Unexpected file format exception
 103  */
 104 class GDCM_EXPORT FormatUnexpected : public Exception
 105 {
 106 public:
 107    /// \brief Builds a file-related exception with minimal information:
 108    /// name of the thrower method and error message
 109    /// @param from name of the thrower
 110    /// @param error error description string
 111    explicit FormatUnexpected(const std::string &from,
 112                              const std::string &error = "Unexpected file format")
 113       throw() : Exception( from, error ) { }
 114 };
 115
 116 //-----------------------------------------------------------------------------
 117 /**
 118  * \brief Invalid file format exception
 119  */
 120 class GDCM_EXPORT FormatError : public FormatUnexpected
 121 {
 122 public:
 123    /// \brief Builds a file-related exception with minimal information:
 124    /// name of the thrower method and error message
 125    /// @param from name of the thrower
 126    /// @param error error description string
 127    explicit FormatError(const std::string &from,
 128                         const std::string &error = "Invalid file format")
 129       throw() : FormatUnexpected( from, error ) { }
 130 };
 131
 132 //-----------------------------------------------------------------------------
 133 /* prints exception stack on output stream
 134  * @param os output stream
 135  * @param e exception to print
 136  * @returns output stream os
 137  */
 138 std::ostream& operator<<(std::ostream &os, const Exception &e);
 139
 140 } // end namespace gdcm
 141
 142 //-----------------------------------------------------------------------------
 143 #endif // GDCM_EXCEPTION_H