Mercurial > hg > orthanc-stone

annotate Framework/Messages/IMessage.h @ 377:8eb4fe74000f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
refactoring
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 05 Nov 2018 16:18:27 +0100
parents 6c22e0506587
children e7a494bdd956
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
1 /**
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
2 * Stone of Orthanc
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
5 * Copyright (C) 2017-2018 Osimis S.A., Belgium
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
6 *
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
10 * the License, or (at your option) any later version.
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
11 *
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
15 * Affero General Public License for more details.
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
16 *
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
19 **/
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
20
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
21
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
22 #pragma once
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
23
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
24 #include "MessageType.h"
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
25
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 250
diff changeset
26 #include <boost/noncopyable.hpp>
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 250
diff changeset
27
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
28 namespace OrthancStone {
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
29
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
30
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
31 // base message that are exchanged between IObservable and IObserver
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
32 class IMessage : public boost::noncopyable
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
33 {
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
34 private:
302
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 299
diff changeset
35 int messageType_;
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
36
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
37 protected:
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
38 IMessage(const int& messageType) :
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
39 messageType_(messageType)
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
40 {
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
41 }
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
42
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
43 public:
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
44 virtual ~IMessage()
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
45 {
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
46 }
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
47
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
48 virtual int GetType() const
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
49 {
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
50 return messageType_;
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
51 }
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
52 };
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
53
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
54
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
55 // base class to derive from to implement your own messages
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
56 // it handles the message type for you
302
4a79193ffb58 support for custom messages + no leaks in unit-tests
am@osimis.io
parents: 299
diff changeset
57 template <int type>
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
58 class BaseMessage : public IMessage
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
59 {
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
60 public:
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
61 enum
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
62 {
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
63 Type = type
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
64 };
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
65
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
66 BaseMessage() :
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
67 IMessage(static_cast<int>(Type))
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
68 {
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
69 }
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
70 };
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
71
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
72
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
73 // simple message implementation when no payload is needed
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
74 // sample usage:
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
75 // typedef NoPayloadMessage<MessageType_LayerSource_GeometryReady> GeometryReadyMessage;
304
am@osimis.io
parents: 302
diff changeset
76 template <int type>
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
77 class NoPayloadMessage : public BaseMessage<type>
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
78 {
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
79 public:
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
80 NoPayloadMessage() :
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
81 BaseMessage<type>()
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
82 {
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
83 }
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
84 };
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
85
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
86 // simple message implementation when no payload is needed but the origin is required
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
87 // sample usage:
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
88 // typedef OriginMessage<MessageType_SliceLoader_GeometryError, OrthancSlicesLoader> SliceGeometryErrorMessage;
304
am@osimis.io
parents: 302
diff changeset
89 template <int type, typename TOrigin>
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
90 class OriginMessage : public BaseMessage<type>
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
91 {
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
92 private:
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
93 TOrigin& origin_;
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
94
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
95 public:
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
96 OriginMessage(TOrigin& origin) :
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
97 BaseMessage<type>(),
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
98 origin_(origin)
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
99 {
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
100 }
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 251
diff changeset
101
377
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
102 TOrigin& GetOrigin() const
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
103 {
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
104 return origin_;
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
105 }
8eb4fe74000f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 304
diff changeset
106 };
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
107 }