#include <string>
+/**\class Events_Error
+ * \ingroup EventsLoop
+ * \brief An error message event.
+ *
+ * Is generated by any algorithm or GUI of the application to inform the user about
+ * the problem. In GUI mode all such errors are collected in the message log window.
+ */
class EVENTS_EXPORT Events_Error : public Events_Message
{
char* myDescription; ///< pointer to the description of the error
- public:
+public:
+ /// default destructor
virtual ~Events_Error();
+ /// Identifier of this event (one for all errors)
static Events_ID errorID();
+ /// Specific error string
char* description() const;
+ /// Allows to send an error quickly: it creates and sends the error object automatically
static void send(char* theDescription, const void* theSender = 0);
+ /// Allows to send an error quickly: it creates and sends the error object automatically
static void send(std::string theDescription, const void* theSender = 0);
- protected:
+protected:
+ /// Default constructor. Use "send" message for generation an error.
Events_Error(char* theDescription, const void* theSender = 0);
};
