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