/usr/include/kido/common/Subject.hpp is in libkido-dev 0.1.0+dfsg-2build9.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 | /*
* Copyright (c) 2015, Georgia Tech Research Corporation
* All rights reserved.
*
* Author(s): Michael X. Grey <mxgrey@gatech.edu>
*
* Georgia Tech Graphics Lab and Humanoid Robotics Lab
*
* Directed by Prof. C. Karen Liu and Prof. Mike Stilman
* <karenliu@cc.gatech.edu> <mstilman@cc.gatech.edu>
*
* This file is provided under the following "BSD-style" License:
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef KIDO_COMMON_SUBJECT_HPP_
#define KIDO_COMMON_SUBJECT_HPP_
#include <set>
namespace kido {
namespace common {
class Observer;
/// The Subject class is a base class for any object that wants to report when
/// it gets destroyed. This is useful for complex frameworks in which it is
/// difficult or impossible to know when an object or resource might destroyed
/// by some other part of the code, or when special cleanup might be needed
/// upon the destruction of an object. Simply by inheriting the Subject class,
/// any class can have the destruction notification feature.
///
/// Note that the Subject class should ALWAYS be virtually inherited. No other
/// special considerations are needed when virtually inheriting the Subject
/// class.
///
/// kido::sub_ptr is a templated smart pointer that will change itself into a
/// nullptr when its Subject is destroyed. It offers one of the easiest ways to
/// take advantage of the Subject/Observer pattern.
class Subject
{
public:
friend class Observer;
/// Destructor will notify all Observers that it is destructing
virtual ~Subject();
protected:
/// Send a destruction notification to all Observers. This will cause all
/// Observers to behave as if this Subject has been permanently deleted, so it
/// should only be called when that behavior is desired.
void sendDestructionNotification() const;
/// Add an Observer to the list of Observers
void addObserver(Observer* _observer) const;
/// Remove an Observer from the list of Observers
void removeObserver(Observer* _observer) const;
/// List of current Observers
mutable std::set<Observer*> mObservers;
};
} // namespace common
} // namespace kido
#endif // KIDO_COMMON_SUBJECT_HPP_
|