X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmException.h;h=436d664a3dfd412d372f6ead94806655a8d430e3;hb=f8273351d460d9f04206e149febc8d1cc7af3fde;hp=fee65d6c748e4a61bfe068c4769cb3f3fd75f789;hpb=29bdd1e88a28b6267618f633f304e1154537ce7b;p=gdcm.git diff --git a/src/gdcmException.h b/src/gdcmException.h index fee65d6c..436d664a 100644 --- a/src/gdcmException.h +++ b/src/gdcmException.h @@ -1,3 +1,5 @@ +// gdcmException.h +//----------------------------------------------------------------------------- #ifndef GDCM_EXCEPTION_H #define GDCM_EXCEPTION_H @@ -6,103 +8,103 @@ #include #include -/** +//----------------------------------------------------------------------------- +/* * Any exception thrown in the gdcm library */ class GDCM_EXPORT gdcmException : public std::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 = "") +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() throw() { - } - - /// 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