* ENH: added some utility method that builds a flat dictionnary

[gdcm.git] / src / gdcmException.h

diff --git a/src/gdcmException.h b/src/gdcmException.h
index 510ef725bbf3c63169b8d8c47ea2db07080e232f..2410c2729d1ec975154814a452c4ef904b6be66d 100644 (file)
--- a/src/gdcmException.h
+++ b/src/gdcmException.h
@@ -1,5 +1,21 @@
-// gdcmException.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmException.h,v $
+  Language:  C++
+  Date:      $Date: 2004/08/16 04:25:18 $
+  Version:   $Revision: 1.15 $
+                                                                                
+  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
+  l'Image). All rights reserved. See Doc/License.txt or
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+                                                                                
+     This software is distributed WITHOUT ANY WARRANTY; without even
+     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+     PURPOSE.  See the above copyright notices for more information.
+                                                                                
+=========================================================================*/
+
 #ifndef GDCM_EXCEPTION_H
 #define GDCM_EXCEPTION_H
 
@@ -12,7 +28,8 @@
 /*
  * Any exception thrown in the gdcm library
  */
-class GDCM_EXPORT gdcmException : public std::exception {
+class GDCM_EXPORT gdcmException : public std::exception
+{
 public:
    /*
     * Builds an exception with minimal information: name of the thrower
@@ -22,20 +39,19 @@ public:
     * @param error error description string
     */
    explicit gdcmException(const std::string &from, const std::string &error = "")
-    throw();
+      throw();
 
    /**
     * \brief virtual destructor makes this class dynamic
     */
-   virtual ~gdcmException() throw() {
-   }
+   virtual ~gdcmException() throw() {};
 
    /// exception caught within exception class: print error message and die
    static void fatal(const char *from) throw();
 
    /// returns error message
-   const std::string &getError(void) const throw() {
-    return error;
+   const std::string &getError() const throw() {
+      return Error;
    }
 
    /// try to discover this (dynamic) class name
@@ -43,7 +59,7 @@ public:
 
    /// returns exception name string (overloads std::exception::what)
    virtual const char *what() const throw() {
-    return (const char *) *this;
+      return (const char *) *this;
    }
 
    /// returns exception name string
@@ -53,9 +69,9 @@ public:
 
 protected:
    /// error message part 1
-   std::string from;
+   std::string From;
    /// error message part 2
-   std::string error;
+   std::string Error;
 };
 
 
@@ -63,7 +79,8 @@ protected:
 /*
  * File error exception thrown in the gdcm library
  */
-class GDCM_EXPORT gdcmFileError : public gdcmException {
+class GDCM_EXPORT gdcmFileError : public gdcmException
+{
 public:
    /**
     * \brief Builds an file-related exception with minimal information: name of
@@ -73,28 +90,40 @@ public:
     */
    explicit gdcmFileError(const std::string &from,
                           const std::string &error = "File error")
-      throw() : gdcmException(from, error) {
-   }
+      throw() : gdcmException(from, error) { }
 };
 
 
 //-----------------------------------------------------------------------------
-/*
- * Invalid file format exception
+/**
+ * \brief Unexpected file format exception
  */
-class GDCM_EXPORT gdcmFormatError : public gdcmException {
+class GDCM_EXPORT gdcmFormatUnexpected : public gdcmException
+{
 public:
-   /*
-    * Builds an file-related exception with minimal information: name of
-    * the thrower method and error message
-    *
-    * @param from name of the thrower
-    * @param error error description string
-    */
+   /// \brief Builds a file-related exception with minimal information:
+   /// name of the thrower method and error message
+   /// @param from name of the thrower
+   /// @param error error description string
+   explicit gdcmFormatUnexpected(const std::string &from,
+                            const std::string &error = "Unexpected file format")
+      throw() : gdcmException( from, error ) { }
+};
+
+//-----------------------------------------------------------------------------
+/**
+ * \brief Invalid file format exception
+ */
+class GDCM_EXPORT gdcmFormatError : public gdcmFormatUnexpected
+{
+public:
+   /// \brief Builds a file-related exception with minimal information:
+   /// name of the thrower method and error message
+   /// @param from name of the thrower
+   /// @param error error description string
    explicit gdcmFormatError(const std::string &from,
-                            const std::string &error = "Invalid file format error")
-      throw() : gdcmException(from, error) {
-   }
+                            const std::string &error = "Invalid file format")
+      throw() : gdcmFormatUnexpected( from, error ) { }
 };
 
 //-----------------------------------------------------------------------------