Changeset 8fe1e2

Timestamp:

Dec 13, 2011, 9:46:12 AM (14 years ago)

Author:

Frederik Heber <heber@…>

Children:

75d156

Parents:

549b62

git-author:

Frederik Heber <heber@…> (12/02/11 09:58:19)

git-committer:

Frederik Heber <heber@…> (12/13/11 09:46:12)

Message:

Added Observable::signOn() to get int wrapped in class PriorityLevel.

• PriorityLevel makes the valid range check.
• also this is preparatory for using size_t channelno instead of the ref to the notification in signing on to channels.
• this is required for relaying notifications.

Location:

src/Patterns

Files:

• Cacheable.hpp (modified) (1 diff)
• Observer/Observable.cpp (modified) (4 diffs)
• Observer/Observable.hpp (modified) (4 diffs)

src/Patterns/Cacheable.hpp

@@ -180 +180 @@
     // we sign on with the best(=lowest) priority, so cached values are recalculated before
     // anybody else might ask for updated values
-    owner->signOn(this,-20);
+    owner->signOn(this,Observable::PriorityLevel(int(-20)));
   }
 

src/Patterns/Observer/Observable.cpp

@@ -20 +20 @@
 #include "MemDebug.hpp"
 
+#include "Observable.hpp"
+
 #include "Assert.hpp"
 #include "Channels.hpp"
+#include "defs.hpp"
 #include "Notification.hpp"
-#include "Observable.hpp"
 
 
@@ -36 +38 @@
 std::map<Observable*, int> Observable::depth;  //!< Map of Observables to the depth of the DAG of Observers
 std::map<Observable*,std::multimap<int,Observer*> > Observable::callTable; //!< Table for each Observable of all its Observers
-std::map<Observable*,std::set<Notification*> > Observable::notifications;
+std::map<Observable*,std::set<Notification*> > Observable::notifications; //!< Table for all current notifications to perform
 std::set<Observable*> Observable::busyObservables; //!< Set of Observables that are currently busy notifying their sign-on'ed Observers
 Observable::ChannelMap Observable::NotificationChannels; //!< Map of Observables to their Channels.
+
+// ValidRange must be initialized before PriorityLevel.
+range<int> Observable::PriorityLevel::ValidRange(-20, 21);
+Observable::PriorityLevel Observable::PriorityDefault(int(0));
+
+/** Constructor of PriorityLevel.
+ *
+ * \note We check whether the level is within Observable::PriorityLevel::ValidRange.
+ *
+ * @param i priority level encapsulated in this class.
+ */
+Observable::PriorityLevel::PriorityLevel(const int i) :
+    level(i)
+{
+  ASSERT(ValidRange.isInRange(level),
+      "Observable::PriorityLevel::PriorityLevel() - Priority level "
+      +toString(level)+" out of range "+toString(ValidRange)+".");
+}
+
+Observable::PriorityLevel::~PriorityLevel()
+{}
 
 /** Attaching Sub-observables to Observables.
@@ -206 +229 @@
  * \param priority number in [-20,20]
  */
-void Observable::signOn(Observer *target,int priority) const
-{
-  ASSERT(priority>=-20 && priority<=+20,
-      "Priority out of range [-20:+20] when signing on Observer");
+void Observable::signOn(Observer *target, PriorityLevel priority) const
+{
 #ifdef LOG_OBSERVER
   observerLog().addMessage() << "@@ Signing on " << observerLog().getName(target) << " to " << observerLog().getName(const_cast<Observable *>(this)) << std::endl;
@@ -221 +242 @@
   }
   if(!res)
-    callees.insert(std::pair<int,Observer*>(priority,target));
+    callees.insert(std::pair<int,Observer*>(priority.level,target));
 }
 

src/Patterns/Observer/Observable.hpp

@@ -18 +18 @@
 #include <string>
 
+#include "Range.hpp"
 #include "Observer/defs.hpp"
 #include "Observer/Observer.hpp"
@@ -35 +36 @@
   virtual ~Observable();
 
+  /** This class is only used to distinguish from size_t in the overload.
+   *
+   * It encapsulates a const int (the priority level) and checks valid bounds
+   * in constructor.
+   *
+   */
+  class PriorityLevel {
+  public:
+    explicit PriorityLevel(const int i);
+    ~PriorityLevel();
+
+    const int level;
+  private:
+    static range<int> ValidRange;
+  };
+
   /**
    * Sign an Observer on to this Observable. The Observer will be notified
@@ -46 +63 @@
    * ussually no need to order the update sequence.
    */
-  virtual void signOn(Observer *target, int priority=0) const;
+  virtual void signOn(Observer *target, PriorityLevel priority = PriorityDefault) const;
 
   /**
@@ -95 +112 @@
   static ChannelMap NotificationChannels;
 
+  static PriorityLevel PriorityDefault;
+
 private:
   typedef std::multimap<int,Observer*> callees_t;