Fix mistypings

[gdcm.git] / src / gdcmException.h

diff --git a/src/gdcmException.h b/src/gdcmException.h
index 2410c2729d1ec975154814a452c4ef904b6be66d..0e46086034dab7f406a9b6fa0dafc88fb5d9e0f9 100644 (file)
--- a/src/gdcmException.h
+++ b/src/gdcmException.h
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmException.h,v $
   Language:  C++
-  Date:      $Date: 2004/08/16 04:25:18 $
-  Version:   $Revision: 1.15 $
+  Date:      $Date: 2007/08/22 16:14:04 $
+  Version:   $Revision: 1.25 $
                                                                                 
   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.
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
                                                                                 
      This software is distributed WITHOUT ANY WARRANTY; without even
      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
@@ -16,56 +16,55 @@
                                                                                 
 =========================================================================*/
 
-#ifndef GDCM_EXCEPTION_H
-#define GDCM_EXCEPTION_H
+#ifndef _GDCM_EXCEPTION_H_
+#define _GDCM_EXCEPTION_H_
 
 #include "gdcmCommon.h"
+
 #include <string>
 #include <iostream>
 #include <exception>
 
+namespace GDCM_NAME_SPACE 
+{
+
 //-----------------------------------------------------------------------------
-/*
- * Any exception thrown in the gdcm library
+/**
+ * \brief Any exception thrown in the gdcm library
  */
-class GDCM_EXPORT gdcmException : public std::exception
+class GDCM_EXPORT Exception : public std::exception
 {
 public:
    /*
-    * Builds an exception with minimal information: name of the thrower
-    * method and error message
-    *
+    * \brief Builds an exception with minimal information: name of the thrower
+    *        method and error message
     * @param from name of the thrower
     * @param error error description string
     */
-   explicit gdcmException(const std::string &from, const std::string &error = "")
+   explicit Exception(const std::string &from, const std::string &error = "")
       throw();
 
    /**
     * \brief virtual destructor makes this class dynamic
     */
-   virtual ~gdcmException() throw() {};
+   virtual ~Exception() 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() const throw() {
-      return Error;
-   }
+   const std::string &getError() const throw() { return Error;}
 
    /// try to discover this (dynamic) class name
    virtual std::string getName() const throw();
 
    /// returns exception name string (overloads std::exception::what)
-   virtual const char *what() const throw() {
-      return (const char *) *this;
-   }
+   virtual const char *what() const throw() { return (const char *) *this;}
 
    /// returns exception name string
    operator const char *() const throw();
 
-   friend std::ostream& operator<<(std::ostream &os, const gdcmException &e);
+   friend std::ostream &operator<<(std::ostream &os, const Exception &e);
 
 protected:
    /// error message part 1
@@ -76,10 +75,10 @@ protected:
 
 
 //-----------------------------------------------------------------------------
-/*
- * File error exception thrown in the gdcm library
+/**
+ * \brief File error exception thrown in the gdcm library
  */
-class GDCM_EXPORT gdcmFileError : public gdcmException
+class GDCM_EXPORT FileError : public Exception
 {
 public:
    /**
@@ -88,9 +87,9 @@ public:
     * @param from name of the thrower
     * @param error error description string
     */
-   explicit gdcmFileError(const std::string &from,
+   explicit FileError(const std::string &from,
                           const std::string &error = "File error")
-      throw() : gdcmException(from, error) { }
+      throw() : Exception(from, error) { }
 };
 
 
@@ -98,32 +97,32 @@ public:
 /**
  * \brief Unexpected file format exception
  */
-class GDCM_EXPORT gdcmFormatUnexpected : public gdcmException
+class GDCM_EXPORT FormatUnexpected : public Exception
 {
 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 gdcmFormatUnexpected(const std::string &from,
-                            const std::string &error = "Unexpected file format")
-      throw() : gdcmException( from, error ) { }
+   explicit FormatUnexpected(const std::string &from,
+                             const std::string &error = "Unexpected file format")
+      throw() : Exception( from, error ) { }
 };
 
 //-----------------------------------------------------------------------------
 /**
  * \brief Invalid file format exception
  */
-class GDCM_EXPORT gdcmFormatError : public gdcmFormatUnexpected
+class GDCM_EXPORT FormatError : public FormatUnexpected
 {
 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")
-      throw() : gdcmFormatUnexpected( from, error ) { }
+   explicit FormatError(const std::string &from,
+                        const std::string &error = "Invalid file format")
+      throw() : FormatUnexpected( from, error ) { }
 };
 
 //-----------------------------------------------------------------------------
@@ -132,7 +131,9 @@ public:
  * @param e exception to print
  * @returns output stream os
  */
-std::ostream& operator<<(std::ostream &os, const gdcmException &e);
+std::ostream& operator<<(std::ostream &os, const Exception &e);
+
+} // end namespace gdcm
 
 //-----------------------------------------------------------------------------
 #endif // GDCM_EXCEPTION_H