1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: Events_InfoMessage.hxx
4 // Created: 31 May 2016
5 // Author: Vitaly SMETANNIKOV
7 #ifndef Events_InfoMessage_H_
8 #define Events_InfoMessage_H_
11 #include <Events_Message.h>
12 #include <Events_Loop.h>
17 /**\class Events_InfoMessage
19 * \brief An event message for sending a string message which has to be translated.
21 class Events_InfoMessage: public Events_Message
26 /// \param theSender a pointer on sender object
27 explicit Events_InfoMessage(const void* theSender = 0):Events_Message(Events_Loop::eventByName("InfoMessage"), theSender) {}
30 /// \param theSender a pointer on sender object
31 Events_InfoMessage(const std::string& theContext,
32 const std::string& theMsg, const void* theSender = 0):
33 Events_Message(Events_Loop::eventByName("InfoMessage"), theSender),
34 myContext(theContext), myMessage(theMsg) {}
36 /// default destructor
37 virtual ~Events_InfoMessage() {}
39 /// Identifier of this event (one for all errors)
40 static Events_ID errorID() { return Events_Loop::loop()->eventByName("InfoMessage"); }
42 /// Set a context string
43 /// \param theContext a context string
44 void setContext(const std::string& theContext) { myContext = theContext; }
47 /// Returns context string
48 std::string context() const { return myContext; }
50 /// Set message string for translation
51 /// \param theMsg the string of message
52 void setMessageString(const std::string& theMsg) { myMessage = theMsg; }
55 std::string messageString() const { return myMessage; }
57 Events_InfoMessage& operator=(const std::string& theMsg) {
58 setMessageString(theMsg);
63 return myMessage.empty();
66 /// Add parameter for message string of string type
67 /// \param theParam the parameter
68 void addParameter(const std::string& theParam)
70 myParameters.push_back(theParam);
73 /// Add parameter for message string of double type
74 /// \param theParam the parameter
75 EVENTS_EXPORT void addParameter(double theParam);
77 /// Add parameter for message string of integer type
78 /// \param theParam the parameter
79 EVENTS_EXPORT void addParameter(int theParam);
81 /// Returns list of parameters
82 std::list<std::string> parameters() const { return myParameters; }
84 /// Add parameter for message string of string type
85 /// \param theParam the parameter
86 Events_InfoMessage& arg(const std::string& theParam) { addParameter(theParam); return *this; }
88 /// Add parameter for message string of integer type
89 /// \param theParam the parameter
90 Events_InfoMessage& arg(int theParam) { addParameter(theParam); return *this; }
92 /// Add parameter for message string of double type
93 /// \param theParam the parameter
94 Events_InfoMessage& arg(double theParam) { addParameter(theParam); return *this; }
97 EVENTS_EXPORT void send();
101 /// Context of the messgae
102 std::string myContext;
104 /// String of the message
105 std::string myMessage;
107 /// Parameters of the message
108 std::list<std::string> myParameters;