DART 6.10.1
Loading...
Searching...
No Matches
Observer.hpp
Go to the documentation of this file.
1/*
2 * Copyright (c) 2011-2021, 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_OBSERVER_HPP_
34#define DART_COMMON_OBSERVER_HPP_
35
36#include <set>
37
38namespace dart {
39namespace common {
40
41class Subject;
42
52{
53public:
54 friend class Subject;
55
57 virtual ~Observer();
58
59protected:
63 void receiveDestructionNotification(const Subject* _subject);
64
67 virtual void handleDestructionNotification(const Subject* _subject);
68
70 void addSubject(const Subject* _subject);
71
73 void removeSubject(const Subject* _subject);
74
76 void removeAllSubjects();
77
79 std::set<const Subject*> mSubjects;
80};
81
82} // namespace common
83} // namespace dart
84
85#endif // DART_COMMON_OBSERVER_HPP_
The Observer class should be inherited by any class that wants to respond in a customized way to the ...
Definition Observer.hpp:52
std::set< const Subject * > mSubjects
List of current Subjects for this Observer.
Definition Observer.hpp:79
virtual void handleDestructionNotification(const Subject *_subject)
Called by receiveDestructionNotification().
Definition Observer.cpp:58
void addSubject(const Subject *_subject)
Add a Subject for this Observer.
Definition Observer.cpp:64
void removeAllSubjects()
Remove all Subjects from this Observer.
Definition Observer.cpp:90
void receiveDestructionNotification(const Subject *_subject)
Called whenever a Subject is destroyed (or sends out a destruction notification).
Definition Observer.cpp:51
void removeSubject(const Subject *_subject)
Remove a Subject from this Observer.
Definition Observer.cpp:77
virtual ~Observer()
Destructor will notify all Subjects that it is destructing.
Definition Observer.cpp:40
The Subject class is a base class for any object that wants to report when it gets destroyed.
Definition Subject.hpp:58
Definition BulletCollisionDetector.cpp:65