]> Creatis software - gdcm.git/blobdiff - src/gdcmException.h
doxygenation
[gdcm.git] / src / gdcmException.h
index 73710ae0528848b72310deca78366c5accfaea61..436d664a3dfd412d372f6ead94806655a8d430e3 100644 (file)
-// gdcmExeption.h
-
-// gdcmlib Intro:  
-// * gdcmlib is a library dedicated to reading and writing dicom files.
-// * LGPL for the license
-// * lightweigth as opposed to CTN or DCMTK which come bundled which try
-//   to implement the full DICOM standard (networking...). gdcmlib concentrates
-//   on reading and writing
-// * Formats: this lib should be able to read ACR-NEMA v1 and v2, Dicom v3 (as
-//   stated in part10). [cf dcmtk/dcmdata/docs/datadict.txt]
-// * Targeted plateforms: Un*xes and Win32/VC++6.0
-//
-//
-
+// gdcmException.h
+//-----------------------------------------------------------------------------
 #ifndef GDCM_EXCEPTION_H
 #define GDCM_EXCEPTION_H
 
+#include "gdcmCommon.h"
 #include <string>
 #include <iostream>
 #include <exception>
-#include "gdcmCommon.h"
 
-/**
+//-----------------------------------------------------------------------------
+/*
  * Any exception thrown in the gdcm library
  */
-class GDCM_EXPORT gdcmException : public exception {
- protected:
-  /// error message
-  std::string from;
-  /// error message
-  std::string error;
-
- public:
-  /**
-   * 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 = "")
+class GDCM_EXPORT gdcmException : public std::exception {
+public:
+   /*
+    * 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 = "")
     throw();
-  
-
-  /**
-   * virtual destructor makes this class dynamic
-   */
-  virtual ~gdcmException() {
-  }
-  
-  /// returns error message
-  const std::string &getError(void) const throw() {
-    return error;
-  }
 
-  /// returns exception name string
-  operator const char *() const throw();
+   /*
+    * virtual destructor makes this class dynamic
+    */
+   virtual ~gdcmException() throw() {
+   }
 
-  /// returns exception name string (overloads std::exception::what)
-  virtual const char *what() const throw() {
-    return (const char *) *this;
-  }
+   // 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;
+   }
 
-  /// exception caught within exception class: print error message and die
-  static void fatal(const char *from) throw();
+   // try to discover this (dynamic) class name
+   virtual std::string getName() const throw();
 
-  /// 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;
+   }
 
-  friend std::ostream& operator<<(std::ostream &os, const gdcmException &e);
-  
-};
+   // returns exception name string
+   operator const char *() const throw();
 
+   friend std::ostream& operator<<(std::ostream &os, const gdcmException &e);
 
-/** prints exception stack on output stream
- * @param os output stream
- * @param e exception to print
- * @returns output stream os
- */
-std::ostream& operator<<(std::ostream &os, const gdcmException &e);
+protected:
+   // error message
+   std::string from;
+   // error message
+   std::string error;
+};
 
 
-/**
+//-----------------------------------------------------------------------------
+/*
  * File error exception thrown in the gdcm library
  */
 class GDCM_EXPORT gdcmFileError : 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
-   */
-  explicit gdcmFileError(const std::string &from,
-                        const std::string &error = "File error")
-    throw() : gdcmException(from, error) {
-  }
+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
+    */
+   explicit gdcmFileError(const std::string &from,
+                          const std::string &error = "File error")
+      throw() : gdcmException(from, error) {
+   }
 };
 
 
-/**
+//-----------------------------------------------------------------------------
+/*
  * Invalid file format exception
  */
 class GDCM_EXPORT gdcmFormatError : 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
-   */
-  explicit gdcmFormatError(const std::string &from,
-                          const std::string &error = "Invalid file format error")
-    throw() : gdcmException(from, error) {
-  }
+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
+    */
+   explicit gdcmFormatError(const std::string &from,
+                            const std::string &error = "Invalid file format error")
+      throw() : gdcmException(from, error) {
+   }
 };
 
+//-----------------------------------------------------------------------------
+/* prints exception stack on output stream
+ * @param os output stream
+ * @param e exception to print
+ * @returns output stream os
+ */
+std::ostream& operator<<(std::ostream &os, const gdcmException &e);
 
+//-----------------------------------------------------------------------------
 #endif // GDCM_EXCEPTION_H