Changes in src/Patterns/Observer.cpp [c296c2:cf1a07]

File:

• src/Patterns/Observer.cpp (modified) (13 diffs)

src/Patterns/Observer.cpp

@@ -24 +24 @@
 // See [Gamma et al, 1995] p. 297
 
-map<Observable*, int> Observable::depth;  //!< Map of Observables to the depth of the DAG of Observers
-map<Observable*,multimap<int,Observer*>*> Observable::callTable; //!< Table for each Observable of all its Observers
-set<Observable*> Observable::busyObservables; //!< Set of Observables that are currently busy notifying their sign-on'ed Observers
+map<Observable*, int> Observable::depth;
+map<Observable*,multimap<int,Observer*>*> Observable::callTable;
+set<Observable*> Observable::busyObservables;
 
-/** Attaching Sub-observables to Observables.
- * Increases entry in Observable::depth for this \a *publisher by one.
- *
- * The two functions \sa start_observer_internal() and \sa finish_observer_internal()
- * have to be used together at all time. Never use these functions directly
- * START_OBSERVER and FINISH_OBSERVER also construct a bogus while(0) loop
- * thus producing compiler-errors whenever only one is used.
- * \param *publisher reference of sub-observable
- */
+// The two functions start_observer_internal and finish_observer_internal
+// have to be used together at all time. Never use these functions directly
+// START_OBSERVER and FINISH_OBSERVER also construct a bogus while(0) loop
+// thus producing compiler-errors whenever only one is used
+
 void Observable::start_observer_internal(Observable *publisher){
   // increase the count for this observable by one
@@ -44 +40 @@
 }
 
-/** Detaching Sub-observables from Observables.
- * Decreases entry in Observable::depth for this \a *publisher by one. If zero, we
- * start notifying all our Observers.
- *
- * The two functions start_observer_internal() and finish_observer_internal()
- * have to be used together at all time. Never use these functions directly
- * START_OBSERVER and FINISH_OBSERVER also construct a bogus while(0) loop
- * thus producing compiler-errors whenever only one is used.
- * \param *publisher reference of sub-observable
- */
 void Observable::finish_observer_internal(Observable *publisher){
   // decrease the count for this observable
@@ -67 +53 @@
 }
 
-/** Constructor for Observable Protector.
- * Basically, calls start_observer_internal(). Hence use this class instead of
- * calling the function directly.
- *
- * \param *protege Observable to be protected.
- */
 Observable::_Observable_protector::_Observable_protector(Observable *_protege) :
   protege(_protege)
@@ -79 +59 @@
 }
 
-/** Destructor for Observable Protector.
- * Basically, calls finish_observer_internal(). Hence use this class instead of
- * calling the function directly.
- *
- * \param *protege Observable to be protected.
- */
 Observable::_Observable_protector::~_Observable_protector()
 {
@@ -92 +66 @@
 /************* Notification mechanism for observables **************/
 
-/** Notify all Observers of changes.
- * Puts \a *this into Observable::busyObservables, calls Observer::update() for all in callee_t
- * and removes from busy list.
- */
+
 void Observable::notifyAll() {
   // we are busy notifying others right now
@@ -108 +79 @@
     callees_t *callees = callTable[this];
     callees_t::iterator iter;
-    for(iter=callees->begin();iter!=callees->end();iter++){
+    for(iter=callees->begin();iter!=callees->end();++iter){
       (*iter).second->update(this);
     }
@@ -116 +87 @@
 }
 
-/** Handles passing on updates from sub-Observables.
- * Mimicks basically the Observer::update() function.
- *
- * \param *publisher The \a *this we observe.
- */
+// this handles passing on updates from sub-Observables
 void Observable::update(Observable *publisher) {
   // circle detection
@@ -142 +109 @@
 }
 
-/** Sign on an Observer to this Observable.
- * Puts \a *target into Observable::callTable list.
- * \param *target Observer
- * \param priority number in [-20,20]
- */
+// methods to sign-on and off
 void Observable::signOn(Observer *target,int priority) {
   assert(priority>=-20 && priority<=+20 && "Priority out of range [-20:+20]");
@@ -160 +123 @@
 
   callees_t::iterator iter;
-  for(iter=callees->begin();iter!=callees->end();iter++){
+  for(iter=callees->begin();iter!=callees->end();++iter){
     res |= ((*iter).second == target);
   }
@@ -167 +130 @@
 }
 
-/** Sign off an Observer from this Observable.
- * Removes \a *target from Observable::callTable list.
- * \param *target Observer
- */
 void Observable::signOff(Observer *target) {
   assert(callTable.count(this) && "SignOff called for an Observable without Observers.");
   callees_t *callees = callTable[this];
   callees_t::iterator iter;
-  callees_t::iterator deliter;
   for(iter=callees->begin();iter!=callees->end();) {
-    deliter=iter++;
-    if((*deliter).second == target)
-      callees->erase(deliter);
+    if((*iter).second == target) {
+      callees->erase(iter++);
+    }
+    else {
+      ++iter;
+    }
   }
   if(callees->empty()){
@@ -187 +148 @@
 }
 
-/** Handles sub-observables that just got killed
- *  when an sub-observerable dies we usually don't need to do anything
- *  \param *publisher Sub-Observable.
- */
+// when an sub-observerable dies we usually don't need to do anything
 void Observable::subjectKilled(Observable *publisher){
 }
 
-/** Constructor for class Observable.
- */
 Observable::Observable()
 {}
 
-/** Destructor for class Observable.
- * When an observable is deleted, we let all our observers know. \sa Observable::subjectKilled().
- */
+// when an observable is deleted, we let all our observers know
 Observable::~Observable()
 {
@@ -208 +162 @@
     callees_t *callees = callTable[this];
     callees_t::iterator iter;
-    for(iter=callees->begin();iter!=callees->end();iter++){
+    for(iter=callees->begin();iter!=callees->end();++iter){
       (*iter).second->subjectKilled(this);
     }
@@ -216 +170 @@
 }
 
-/** Constructor for class Observer.
- */
 Observer::Observer()
 {}
 
-/** Destructor for class Observer.
- */
 Observer::~Observer()
 {}