src/Events/Events_InfoMessage.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        Events_InfoMessage.hxx
   4 // Created:     31 May 2016
   5 // Author:      Vitaly SMETANNIKOV
   6
   7 #ifndef Events_InfoMessage_H_
   8 #define Events_InfoMessage_H_
   9
  10 #include <Events.h>
  11 #include <Events_Message.h>
  12 #include <Events_Loop.h>
  13
  14 #include <string>
  15 #include <list>
  16
  17 /**\class Events_InfoMessage
  18  * \ingroup EventsLoop
  19  * \brief An event message for sending a string message which has to be translated.
  20  */
  21 class Events_InfoMessage: public Events_Message
  22 {
  23 public:
  24
  25   /// Constructor
  26   /// \param theSender a pointer on sender object
  27   explicit Events_InfoMessage(const void* theSender = 0):Events_Message(Events_Loop::eventByName("InfoMessage"), theSender) {}
  28
  29   /// Constructor
  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) {}
  35
  36   /// default destructor
  37   virtual ~Events_InfoMessage() {}
  38
  39   /// Identifier of this event (one for all errors)
  40   static Events_ID errorID()  { return Events_Loop::loop()->eventByName("InfoMessage"); }
  41
  42   /// Set a context string
  43   /// \param theContext a context string
  44   void  setContext(const std::string& theContext) { myContext = theContext; }
  45
  46
  47   /// Returns context string
  48   std::string context() const { return myContext; }
  49
  50   /// Set message string for translation
  51   /// \param theMsg the string of message
  52   void setMessageString(const std::string& theMsg) { myMessage = theMsg; }
  53
  54   /// Returns message
  55   std::string messageString() const { return myMessage; }
  56
  57   Events_InfoMessage& operator=(const std::string& theMsg) {
  58     setMessageString(theMsg);
  59     return *this;
  60   }
  61
  62   bool empty() const {
  63     return myMessage.empty();
  64   }
  65
  66   /// Add parameter for message string of string type
  67   /// \param theParam the parameter
  68   void addParameter(const std::string& theParam)
  69   {
  70     myParameters.push_back(theParam);
  71   }
  72
  73   /// Add parameter for message string of double type
  74   /// \param theParam the parameter
  75   EVENTS_EXPORT void addParameter(double theParam);
  76
  77   /// Add parameter for message string of integer type
  78   /// \param theParam the parameter
  79   EVENTS_EXPORT void addParameter(int theParam);
  80
  81   /// Returns list of parameters
  82   std::list<std::string> parameters() const { return myParameters; }
  83
  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; }
  87
  88   /// Add parameter for message string of integer type
  89   /// \param theParam the parameter
  90   Events_InfoMessage& arg(int theParam) { addParameter(theParam); return *this; }
  91
  92   /// Add parameter for message string of double type
  93   /// \param theParam the parameter
  94   Events_InfoMessage& arg(double theParam) { addParameter(theParam); return *this; }
  95
  96   /// Send the message
  97   EVENTS_EXPORT void send();
  98
  99 private:
 100
 101   /// Context of the messgae
 102   std::string myContext;
 103
 104   /// String of the message
 105   std::string myMessage;
 106
 107   /// Parameters of the message
 108   std::list<std::string> myParameters;
 109 };
 110
 111 #endif