File: observable.hpp

package info (click to toggle)
quantlib 0.2.1.cvs20020322-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 4,716 kB
  • ctags: 4,614
  • sloc: cpp: 19,601; sh: 7,389; makefile: 796; ansic: 22
file content (144 lines) | stat: -rw-r--r-- 4,843 bytes parent folder | download
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

/*
 Copyright (C) 2000, 2001, 2002 RiskMap srl

 This file is part of QuantLib, a free-software/open-source library
 for financial quantitative analysts and developers - http://quantlib.org/

 QuantLib is free software: you can redistribute it and/or modify it under the
 terms of the QuantLib license.  You should have received a copy of the
 license along with this program; if not, please email ferdinando@ametrano.net
 The license is also available online at http://quantlib.org/html/license.html

 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE.  See the license for more details.
*/
/*! \file observable.hpp
    \brief observer/observable pattern

    \fullpath
    ql/Patterns/%observable.hpp
*/

// $Id: observable.hpp,v 1.9 2002/03/06 14:59:37 nando Exp $

#ifndef quantlib_observable_h
#define quantlib_observable_h

#include <ql/handle.hpp>
#include <list>
#include <algorithm>

namespace QuantLib {

    //! Implementations of design patterns
    /*! See sect. \ref patterns */
    namespace Patterns {

        //! Object that notifies its changes to a set of observables
        class Observable {
            friend class Observer;
          public:
            virtual ~Observable() {}
            /*! This method should be called at the end of non-const methods 
                or when the programmer desires to notify any changes.
            */
            void notifyObservers();
          private:
            void registerObserver(Observer*);
            void unregisterObserver(Observer*);
            std::list<Observer*> observers_;
            typedef std::list<Observer*>::iterator iterator;
        };


        //! Object that gets notified when a given observable changes
        class Observer {
          public:
            // constructors, assignment, destructor
            Observer() {}
            Observer(const Observer&);
            Observer& operator=(const Observer&);
            virtual ~Observer();
            // observer interface
            void registerWith(const Handle<Observable>&);
            void unregisterWith(const Handle<Observable>&);
            /*! This method must be implemented in derived classes. An
                instance of %Observer does not call this method directly:
                instead, it will be called by the observables the instance
                registered with when they need to notify any changes.
            */
            virtual void update() = 0;
          private:
            std::list<Handle<Observable> > observables_;
            typedef std::list<Handle<Observable> >::iterator iterator;
        };


        // inline definitions

        inline void Observable::registerObserver(Observer* o) {
            observers_.push_front(o);
        }

        inline void Observable::unregisterObserver(Observer* o) {
            iterator i = std::find(observers_.begin(),observers_.end(),o);
            if (i != observers_.end())
                observers_.erase(i);
        }

        inline void Observable::notifyObservers() {
            for (iterator i=observers_.begin(); i!=observers_.end(); ++i)
                (*i)->update();
        }


        inline Observer::Observer(const Observer& o)
        : observables_(o.observables_) {
            for (iterator i=observables_.begin(); i!=observables_.end(); ++i)
                (*i)->registerObserver(this);
        }
        
        inline Observer& Observer::operator=(const Observer& o) {
            iterator i;
            for (i=observables_.begin(); i!=observables_.end(); ++i)
                (*i)->unregisterObserver(this);
            observables_ = o.observables_;
            for (i=observables_.begin(); i!=observables_.end(); ++i)
                (*i)->registerObserver(this);
            return *this;
        }

        inline Observer::~Observer() {
            for (iterator i=observables_.begin(); i!=observables_.end(); ++i)
                (*i)->unregisterObserver(this);
        }

        inline void Observer::registerWith(const Handle<Observable>& h) {
            if (!h.isNull()) {
                observables_.push_front(h);
                h->registerObserver(this);
            }
        }

        inline void Observer::unregisterWith(const Handle<Observable>& h) {
            if (!h.isNull()) {
                for (iterator i=observables_.begin(); 
                              i!=observables_.end(); 
                              ++i) {
                    if (h.shareSameObject(*i)) {
                        (*i)->unregisterObserver(this);
                        observables_.erase(i);
                        return;
                    }
                }
            }
        }
            
    }

}


#endif