src/Events/Events_MessageBool.h

   1 // Copyright (C) 2014-2021  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef Events_MessageBool_H_
  21 #define Events_MessageBool_H_
  22
  23 #include <Events.h>
  24 #include <Events_Message.h>
  25 #include <Events_Loop.h>
  26
  27 #include <string>
  28 #include <list>
  29
  30 /**\class Events_MessageBool
  31  * \ingroup EventsLoop
  32  * \brief An event message for sending a message with a boolean value.
  33  *        May be used for different where just a Boolean flag is needed to send.
  34  */
  35 class Events_MessageBool: public Events_Message
  36 {
  37 public:
  38
  39   /// Constructor
  40   /// \param theEventID an indentifier of the message
  41   /// \param theValue a Boolean value to send
  42   /// \param theSender a pointer on sender object
  43   Events_MessageBool(const Events_ID theEventID, const bool theValue, const void* theSender = 0):
  44   Events_Message(theEventID, theSender), myValue(theValue) {}
  45
  46   /// Default destructor
  47   virtual ~Events_MessageBool() {}
  48
  49   /// Returns the value stored in this message.
  50   const bool value() const { return myValue; }
  51
  52   /// Sends the message
  53   EVENTS_EXPORT void send();
  54
  55 private:
  56
  57   /// The stored value
  58   bool myValue;
  59
  60 };
  61
  62 #endif