- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

# D:/Programmation/Sources/Tensor2/Utils/include/frost_utils_exception.h

Go to the documentation of this file.

    00001 /* ###################################### */
    00002 /* ###     Frost Engine, by Kalith    ### */
    00003 /* ###################################### */
    00004 /*            Exception header            */
    00005 /*                                        */
    00006 /*                                        */
    00007
    00008 #ifndef FROST_EXCEPTION_H
    00009 #define FROST_EXCEPTION_H
    00010
    00011 #include "frost_utils_types.h"
    00012
    00013 namespace Frost
    00014 {
    00015     /// Frost's exception class.
    00016     class Exception
    00017     {
    00018     public :
    00019
    00020         /// Default exception.
    00021         /** \note Reports : "Undefined exception."
    00022         */
    00023         Exception();
    00024
    00025         /// Simple message exception.
    00026         /** \param sMessage The message to throw
    00027         *   \note Reports : "<sMessage>"
    00028         */
    00029         Exception(const s_str& sMessage);
    00030
    00031         /// Class name + message exception.
    00032         /** \param sClassName The name of the class which throws the exception
    00033         *   \param sMessage   The message to throw
    00034         *   \note Reports : "<sClassName> : <sMessage>"
    00035         */
    00036         Exception(const s_str& sClassName, const s_str& sMessage);
    00037
    00038         /// Destructor.
    00039         virtual ~Exception();
    00040
    00041         /// Returns the message of the exception.
    00042         /** \return The message of the exception
    00043         */
    00044         const s_str& GetDescription() const;
    00045
    00046     protected :
    00047
    00048         s_str sMessage_;
    00049     };
    00050 }
    00051
    00052 #endif