Changeset 317df8

Timestamp:

Feb 3, 2010, 4:31:45 PM (15 years ago)

Author:

Tillmann Crueger <crueger@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, AddingActions_SaveParseParticleParameters, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_ParticleName_to_Atom, Adding_StructOpt_integration_tests, AtomFragments, Automaking_mpqc_open, AutomationFragmentation_failures, Candidate_v1.5.4, Candidate_v1.6.0, Candidate_v1.6.1, ChangeBugEmailaddress, ChangingTestPorts, ChemicalSpaceEvaluator, CombiningParticlePotentialParsing, Combining_Subpackages, Debian_Package_split, Debian_package_split_molecuildergui_only, Disabling_MemDebug, Docu_Python_wait, EmpiricalPotential_contain_HomologyGraph, EmpiricalPotential_contain_HomologyGraph_documentation, Enable_parallel_make_install, Enhance_userguide, Enhanced_StructuralOptimization, Enhanced_StructuralOptimization_continued, Example_ManyWaysToTranslateAtom, Exclude_Hydrogens_annealWithBondGraph, FitPartialCharges_GlobalError, Fix_BoundInBox_CenterInBox_MoleculeActions, Fix_ChargeSampling_PBC, Fix_ChronosMutex, Fix_FitPartialCharges, Fix_FitPotential_needs_atomicnumbers, Fix_ForceAnnealing, Fix_IndependentFragmentGrids, Fix_ParseParticles, Fix_ParseParticles_split_forward_backward_Actions, Fix_PopActions, Fix_QtFragmentList_sorted_selection, Fix_Restrictedkeyset_FragmentMolecule, Fix_StatusMsg, Fix_StepWorldTime_single_argument, Fix_Verbose_Codepatterns, Fix_fitting_potentials, Fixes, ForceAnnealing_goodresults, ForceAnnealing_oldresults, ForceAnnealing_tocheck, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, FragmentAction_writes_AtomFragments, FragmentMolecule_checks_bonddegrees, GeometryObjects, Gui_Fixes, Gui_displays_atomic_force_velocity, ImplicitCharges, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, MoreRobust_FragmentAutomation, ODR_violation_mpqc_open, PartialCharges_OrthogonalSummation, PdbParser_setsAtomName, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, Rewrite_FitPartialCharges, RotateToPrincipalAxisSystem_UndoRedo, SaturateAtoms_findBestMatching, SaturateAtoms_singleDegree, StoppableMakroAction, Subpackage_CodePatterns, Subpackage_JobMarket, Subpackage_LinearAlgebra, Subpackage_levmar, Subpackage_mpqc_open, Subpackage_vmg, Switchable_LogView, ThirdParty_MPQC_rebuilt_buildsystem, TrajectoryDependenant_MaxOrder, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps, TremoloParser_setsAtomName, Ubuntu_1604_changes, stable

Children:

2ba827

Parents:

5d1611

Message:

Changed Observer to use RAII-style for locking changes.

Location:

src

Files:

• Patterns/Observer.cpp (modified) (1 diff)
• Patterns/Observer.hpp (modified) (3 diffs)
• unittests/ObserverTest.cpp (modified) (3 diffs)

src/Patterns/Observer.cpp

@@ -51 +51 @@
     depth.erase(publisher);
   }
+}
+
+Observable::_Observable_protector::_Observable_protector(Observable *_protege) :
+  protege(_protege)
+{
+  start_observer_internal(protege);
+}
+
+Observable::_Observable_protector::~_Observable_protector()
+{
+  finish_observer_internal(protege);
 }
 

src/Patterns/Observer.hpp

@@ -16 +16 @@
  *
  * Observers register themselves with the observables to be notified when something changes.
- * In the Observable code that changes attributes should be wrapped in
- * START_OBSERVER ... END_OBSERVER blocks. If other methods are called that also contain
- * Observation blocks from there, these functions wont trigger notifications. Only the end
- * of the final observation block triggers the update of Observers.
- *
- * Returning from observed code should be done using the RETURN_OBSERVER() macro. This way the Observer mechanism
- * is notified that the method is left.
+ * In the Observable code that changes attributes should be started with OBSERVE;. This macro
+ * locks the observer mechanism while changes are done. At the end of the scope in which the
+ * macro was placed the lock is released. When the last lock is released all changes are
+ * propagated to the observers.
  *
  * Each observerable can have sub-observables. When one of these sub-observables changes and
@@ -62 +59 @@
   /**
    * Internal method.
-   * Do not call directly. Use START_OBSERVER macro instead
+   * Do not call directly. Use OBSERVE macro instead
    */
   static void start_observer_internal(Observable *publisher);
   /**
    * Internal method.
-   * Do not call directly. Use FINISH_OBSERVER macro instead
+   * Do not call directly. Use OBSERVE macro instead
    */
   static void finish_observer_internal(Observable *publisher);
@@ -76 +73 @@
   static std::map<Observable*,callees_t*> callTable;
   static std::set<Observable*> busyObservables;
+
+  // Structure for RAII-Style notification
+protected:
+  class _Observable_protector {
+  public:
+    _Observable_protector(Observable *);
+    ~_Observable_protector();
+  private:
+    Observable *protege;
+  };
 };
 
 
-
+#define OBSERVE Observable::_Observable_protector _scope_obs_protector(this)
 #define START_OBSERVER Observable::start_observer_internal(this);do{do{}while(0)
 #define FINISH_OBSERVER }while(0);Observable::finish_observer_internal(this)

src/unittests/ObserverTest.cpp

@@ -39 +39 @@
 public:
   void changeMethod() {
-    START_OBSERVER;
-    int i;
-    i++;
-    FINISH_OBSERVER;
+    OBSERVE;
+    int i;
+    i++;
   }
 };
@@ -49 +48 @@
 public:
   void changeMethod1() {
-    START_OBSERVER;
-    int i;
-    i++;
-    FINISH_OBSERVER;
+    OBSERVE;
+    int i;
+    i++;
   }
 
   void changeMethod2() {
-    START_OBSERVER;
+    OBSERVE;
     int i;
     i++;
     changeMethod1();
-    FINISH_OBSERVER;
   }
 };
@@ -74 +71 @@
   }
   void changeMethod() {
-    START_OBSERVER;
+    OBSERVE;
     int i;
     i++;
     subObservable->changeMethod();
-    FINISH_OBSERVER;
   }
   SimpleObservable *subObservable;