Mercurial > hg > orthanc-stone

annotate Framework/Messages/IObservable.h @ 267:89d02de83c03 am-2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added declaretion of messages handled/emitted
author am@osimis.io
date Wed, 22 Aug 2018 14:59:20 +0200
parents c9cf95b49a86
children 5bd4161bf11b
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
267
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
24 #include <set>
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
25 #include <assert.h>
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
26 #include <algorithm>
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
27 #include <iostream>
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
28
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
29 #include "MessageBroker.h"
267
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
30 #include "MessageType.h"
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
31 #include "IObserver.h"
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
32
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
33 namespace OrthancStone {
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
34
267
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
35 class MessageNotDeclaredException : public std::logic_error
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
36 {
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
37 MessageType messageType_;
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
38 public:
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
39 MessageNotDeclaredException(MessageType messageType)
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
40 : std::logic_error("Message not declared by observer."),
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
41 messageType_(messageType)
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
42 {
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
43 }
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
44 };
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
45
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
46 class IObservable : public boost::noncopyable
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
47 {
258
e5a9b3d03478 first very basic version of SmartLoader
am@osimis.io
parents: 250
diff changeset
48 protected:
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
49 MessageBroker& broker_;
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
50
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
51 std::set<IObserver*> observers_;
267
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
52 std::set<MessageType> emittableMessages_;
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
53
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
54 public:
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
55
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
56 IObservable(MessageBroker& broker)
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
57 : broker_(broker)
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
58 {
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
59 }
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
60 virtual ~IObservable()
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
61 {
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
62 }
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
63
266
c9cf95b49a86 removed OrthancSlicesLoader::ISliceLoaderObserver; now using standard messages instead
am@osimis.io
parents: 258
diff changeset
64 void EmitMessage(const IMessage& message) const
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
65 {
267
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
66 if (emittableMessages_.find(message.GetType()) == emittableMessages_.end())
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
67 {
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
68 throw MessageNotDeclaredException(message.GetType());
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
69 }
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
70
258
e5a9b3d03478 first very basic version of SmartLoader
am@osimis.io
parents: 250
diff changeset
71 broker_.EmitMessage(*this, observers_, message);
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
72 }
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
73
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
74 void RegisterObserver(IObserver& observer)
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
75 {
267
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
76 CheckObserverDeclaredAllObservableMessages(observer);
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
77 observers_.insert(&observer);
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
78 }
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
79
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
80 void UnregisterObserver(IObserver& observer)
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
81 {
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
82 observers_.erase(&observer);
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
83 }
267
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
84
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
85 const std::set<MessageType>& GetEmittableMessages() const
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
86 {
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
87 return emittableMessages_;
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
88 }
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
89
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
90 protected:
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
91
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
92 void DeclareEmittableMessage(MessageType messageType)
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
93 {
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
94 emittableMessages_.insert(messageType);
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
95 }
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
96
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
97 void CheckObserverDeclaredAllObservableMessages(IObserver& observer)
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
98 {
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
99 for (std::set<MessageType>::const_iterator it = emittableMessages_.begin(); it != emittableMessages_.end(); it++)
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
100 {
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
101 // the observer must have "declared" all observable messages
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
102 if (observer.GetHandledMessages().find(*it) == observer.GetHandledMessages().end()
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
103 && observer.GetIgnoredMessages().find(*it) == observer.GetIgnoredMessages().end())
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
104 {
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
105 throw MessageNotDeclaredException(*it);
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
106 }
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
107 }
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 266
diff changeset
108 }
250
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
109 };
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
110
5e642859267e added new Observable/Observer & MessageBroker (not used yet)
am@osimis.io
parents:
diff changeset
111 }