Changeset b64313

Timestamp:

Mar 19, 2010, 4:13:28 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:

760ef4

Parents:

e0b6fd

Message:

Improved Observer Framework to include methods to report the state

• bool Observable::isBlocked() will tell if the Observer is currently updating itself
• The Circle detection test now uses ASSERT to report when a circle was detected (can be caught by CPPUNIT)

Location:

src

Files:

• Patterns/Observer.cpp (modified) (5 diffs)
• Patterns/Observer.hpp (modified) (3 diffs)
• unittests/ObserverTest.cpp (modified) (6 diffs)
• unittests/ObserverTest.hpp (modified) (4 diffs)

src/Patterns/Observer.cpp

@@ -10 +10 @@
 
 #include <iostream>
-#include <cassert>
+
+#include "Helpers/Assert.hpp"
 
 using namespace std;
@@ -133 +134 @@
     // observers, but still we are called by one of our sub-Observables
     // we cannot be sure observation will still work at this point
-    cerr << "Circle detected in observation-graph." << endl;
-    cerr << "Observation-graph always needs to be a DAG to work correctly!" << endl;
-    cerr << "Please check your observation code and fix this!" << endl;
+    ASSERT(0,"Circle detected in observation-graph.\n"
+             "Observation-graph always needs to be a DAG to work correctly!\n"
+             "Please check your observation code and fix this!\n");
     return;
   }
@@ -154 +155 @@
  */
 void Observable::signOn(Observer *target,int priority) {
-  assert(priority>=-20 && priority<=+20 && "Priority out of range [-20:+20]");
+  ASSERT(priority>=-20 && priority<=+20, "Priority out of range [-20:+20] when signing on Observer");
   bool res = false;
   callees_t *callees = 0;
@@ -178 +179 @@
  */
 void Observable::signOff(Observer *target) {
-  assert(callTable.count(this) && "SignOff called for an Observable without Observers.");
+  ASSERT(callTable.count(this),"SignOff called for an Observable without Observers.");
   callees_t *callees = callTable[this];
   callees_t::iterator iter;
@@ -196 +197 @@
 }
 
+bool Observable::isBlocked(){
+  return depth.count(this) > 0;
+}
+
 /** Handles sub-observables that just got killed
  *  when an sub-observerable dies we usually don't need to do anything

src/Patterns/Observer.hpp

@@ -98 +98 @@
   virtual void signOff(Observer *target);
 
+  /**
+   * Ask an Observer if it is currently in a blocked state, i.e. if
+   * Changes are in Progress, that are not yet published.
+   */
+  virtual bool isBlocked();
+
 protected:
   virtual void update(Observable *publisher);
@@ -122 +128 @@
   static std::set<Observable*> busyObservables;
 
+  //! @cond
   // Structure for RAII-Style notification
 protected:
@@ -137 +144 @@
     Observable *protege;
   };
+  //! @endcond
 };
 

src/unittests/ObserverTest.cpp

@@ -15 +15 @@
 #include "Patterns/Observer.hpp"
 #include "Patterns/ObservedIterator.hpp"
+#include "Helpers/Assert.hpp"
 
 #include <iostream>
@@ -64 +65 @@
     i++;
     changeMethod1();
+  }
+};
+
+class BlockObservable : public Observable {
+public:
+  void changeMethod1(){
+    OBSERVE;
+    // test if we report correctly as blocked
+    CPPUNIT_ASSERT(isBlocked());
+  }
+
+  void changeMethod2(){
+    OBSERVE;
+    internalMethod1();
+    internalMethod2();
+  }
+
+  void internalMethod1(){
+    // we did not block, but our caller did...
+    // see if this is found
+    CPPUNIT_ASSERT(isBlocked());
+  }
+
+  void internalMethod2(){
+    OBSERVE;
+    // Both this method and the caller do block
+    // Does the reporting still work as expected?
+    CPPUNIT_ASSERT(isBlocked());
+  }
+
+  void noChangeMethod(){
+    // No Block introduced here
+    // reported correctely?
+    CPPUNIT_ASSERT(!isBlocked());
   }
 };
@@ -120 +155 @@
 
 void ObserverTest::setUp() {
+  ASSERT_DO(Assert::Throw);
   simpleObservable1 = new SimpleObservable();
   simpleObservable2 = new SimpleObservable();
   callObservable = new CallObservable();
   superObservable = new SuperObservable();
+  blockObservable = new BlockObservable();
 
   observer1 = new UpdateCountObserver();
@@ -199 +236 @@
   CPPUNIT_ASSERT_EQUAL( 2, observer1->updates );
   CPPUNIT_ASSERT_EQUAL( 2, observer2->updates );
+}
+
+void ObserverTest::doesReportTest(){
+  // Actual checks are in the Stub-methods for this
+  blockObservable->changeMethod1();
+  blockObservable->changeMethod2();
+  blockObservable->noChangeMethod();
 }
 
@@ -227 +271 @@
   // make this Observable its own subject. NEVER DO THIS IN ACTUAL CODE
   simpleObservable1->signOn(simpleObservable1);
-  simpleObservable1->changeMethod();
+  CPPUNIT_ASSERT_THROW(simpleObservable1->changeMethod(),Assert::AssertionFailure);
 
   // more complex test
@@ -233 +277 @@
   simpleObservable1->signOn(simpleObservable2);
   simpleObservable2->signOn(simpleObservable1);
-  simpleObservable1->changeMethod();
+  CPPUNIT_ASSERT_THROW(simpleObservable1->changeMethod(),Assert::AssertionFailure);
   simpleObservable1->signOff(simpleObservable2);
   simpleObservable2->signOff(simpleObservable1);

src/unittests/ObserverTest.hpp

@@ -17 +17 @@
 class SuperObservable;
 class ObservableCollection;
+class BlockObservable;
 
 
@@ -25 +26 @@
   CPPUNIT_TEST ( doesBlockUpdateTest );
   CPPUNIT_TEST ( doesSubObservableTest );
+  CPPUNIT_TEST ( doesReportTest );
   CPPUNIT_TEST ( iteratorTest );
   CPPUNIT_TEST ( CircleDetectionTest );
@@ -36 +38 @@
   void doesBlockUpdateTest();
   void doesSubObservableTest();
+  void doesReportTest();
   void iteratorTest();
   void CircleDetectionTest();
@@ -48 +51 @@
   SimpleObservable *simpleObservable2;
   CallObservable *callObservable;
+  BlockObservable *blockObservable;
   SuperObservable *superObservable;