src/Events/Events_MessageGroup.h

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef Events_MessageGroup_H_
  22 #define Events_MessageGroup_H_
  23
  24 #include <Events_Message.h>
  25 #include <memory>
  26
  27 /**\class Events_MessageGroup
  28  * \ingroup EventsLoop
  29  * \brief Message that allows to group messages and send them later as a group of messages.
  30  *
  31  * Loop detects such messages and accumulates them without sending. On "flush" loop sends it
  32  * as a group-message.
  33  */
  34 class EVENTS_EXPORT Events_MessageGroup : public Events_Message
  35 {
  36
  37  public:
  38
  39   //! Creates the message
  40   Events_MessageGroup(const Events_ID theID, const void* theSender = 0);
  41   //! do nothing in the destructor yet
  42   virtual ~Events_MessageGroup();
  43
  44   //! Creates a new empty group (to store it in the loop before flush)
  45   virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
  46   //! Allows to join the given message with the current one
  47   virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
  48 };
  49
  50 #endif