DART  6.7.3
Subject.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2019, The DART development contributors
3  * All rights reserved.
4  *
5  * The list of contributors can be found at:
6  * https://github.com/dartsim/dart/blob/master/LICENSE
7  *
8  * This file is provided under the following "BSD-style" License:
9  * Redistribution and use in source and binary forms, with or
10  * without modification, are permitted provided that the following
11  * conditions are met:
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef DART_COMMON_SUBJECT_HPP_
34 #define DART_COMMON_SUBJECT_HPP_
35 
36 #include <set>
37 
38 namespace dart {
39 namespace common {
40 
41 class Observer;
42 
57 class Subject
58 {
59 public:
60 
61  friend class Observer;
62 
64  virtual ~Subject();
65 
66 protected:
67 
71  void sendDestructionNotification() const;
72 
74  void addObserver(Observer* _observer) const;
75 
77  void removeObserver(Observer* _observer) const;
78 
80  mutable std::set<Observer*> mObservers;
81 
82 };
83 
84 } // namespace common
85 } // namespace dart
86 
87 #endif // DART_COMMON_SUBJECT_HPP_
The Observer class should be inherited by any class that wants to respond in a customized way to the ...
Definition: Observer.hpp:52
The Subject class is a base class for any object that wants to report when it gets destroyed.
Definition: Subject.hpp:58
void removeObserver(Observer *_observer) const
Remove an Observer from the list of Observers.
Definition: Subject.cpp:70
virtual ~Subject()
Destructor will notify all Observers that it is destructing.
Definition: Subject.cpp:40
void sendDestructionNotification() const
Send a destruction notification to all Observers.
Definition: Subject.cpp:46
std::set< Observer * > mObservers
List of current Observers.
Definition: Subject.hpp:80
void addObserver(Observer *_observer) const
Add an Observer to the list of Observers.
Definition: Subject.cpp:57
Definition: BulletCollisionDetector.cpp:63