Changeset a40c85 for src/Fragmentation

Timestamp:

Jul 2, 2012, 8:31:57 AM (12 years ago)

Author:

Frederik Heber <heber@…>

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:

ba995d

Parents:

9a6b895

git-author:

Frederik Heber <heber@…> (04/24/12 14:58:50)

git-committer:

Frederik Heber <heber@…> (07/02/12 08:31:57)

Message:

FragmentScheduler is relieved of observering Operations, is done by OperationQueue.

• i.e. OperationQueue is now an Observer and uses push_back() and remove() to sign on and off from the given operations.
• added unit test function to check this behavior.

Location:

src/Fragmentation/Automation

Files:

• FragmentScheduler.cpp (modified) (1 diff)
• Operations/OperationQueue.cpp (modified) (2 diffs)
• Operations/OperationQueue.hpp (modified) (4 diffs)
• unittests/OperationQueueUnitTest.cpp (modified) (3 diffs)
• unittests/OperationQueueUnitTest.hpp (modified) (2 diffs)

src/Fragmentation/Automation/FragmentScheduler.cpp

@@ -587 +587 @@
 void FragmentScheduler::update(Observable *publisher)
 {
-  AsyncOperation *op = static_cast<AsyncOperation *>(publisher);
-  if (op != NULL) {
-    LOG(1, "INFO: We are note notified that " << op->getName() << " is done, removing ...");
-
-    // remove from queue
-    OpQueue.remove(op, this);
-  }
+  ASSERT(0, "FragmentScheduler::update() - we are not signed on for global updates.");
 }
 

src/Fragmentation/Automation/Operations/OperationQueue.cpp

@@ -47 +47 @@
   if (op != NULL) {
     AsyncOp_ptr ptr(op); // this always prevents memory loss
+    ptr->signOn(this);
     queue.push_back( ptr );
     op = NULL;
@@ -73 +74 @@
   }
 }
+
+void OperationQueue::update(Observable *publisher)
+{
+  AsyncOperation *op = static_cast<AsyncOperation *>(publisher);
+  if (op != NULL) {
+    LOG(1, "INFO: We are note notified that " << op->getName() << " is done, removing ...");
+    // remove from queue
+    remove(op, this);
+  }
+}
+
+void OperationQueue::recieveNotification(Observable *publisher, Notification_ptr notification)
+{}
+
+void OperationQueue::subjectKilled(Observable *publisher)
+{
+  AsyncOperation *op = static_cast<AsyncOperation *>(publisher);
+  if (op != NULL) {
+    ELOG(2, "DEBUG: AsyncOperation at " << publisher << " got killed before being done?");
+    // remove from queue
+    remove(op, this);
+  }
+}
+

src/Fragmentation/Automation/Operations/OperationQueue.hpp

@@ -18 +18 @@
 #include <deque>
 
+#include "CodePatterns/Observer/Observer.hpp"
+
 class AsyncOperation;
 class Observer;
@@ -26 +28 @@
  * and removed when the operation is done.
  */
-class OperationQueue
+class OperationQueue : public Observer
 {
   //!> grant unit test access to private part
   friend class OperationQueueTest;
 public:
+  /** Default constructor for class OperationQueue.
+   *
+   */
+  OperationQueue() :
+    Observer("OperationQueue")
+  {}
+  /** Default destructor for class OperationQueue.
+   *
+   */
+  virtual ~OperationQueue()
+  {}
+
   typedef boost::shared_ptr<AsyncOperation> AsyncOp_ptr;
 
@@ -40 +54 @@
   void push_back(AsyncOperation *&op, const WorkerAddress &address);
 
+  void update(Observable *publisher);
+  void recieveNotification(Observable *publisher, Notification_ptr notification);
+  void subjectKilled(Observable *publisher);
+
+private:
   /** Removes an operation from the queue.
    *
@@ -47 +66 @@
   void remove(AsyncOperation *op, Observer *observer);
 
-private:
   //!> internal operation to send jobs to workers
   typedef std::deque<AsyncOp_ptr> OperationQueue_t;

src/Fragmentation/Automation/unittests/OperationQueueUnitTest.cpp

@@ -83 +83 @@
   CPPUNIT_ASSERT( queue->findOperation(backup) != queue->queue.end() );
   CPPUNIT_ASSERT( queue->findOperation(otherbackup) != queue->queue.end() );
+
+  std::cout << "The following warning's do not indicate a failure." << std::endl;
 }
 
@@ -97 +99 @@
   CPPUNIT_ASSERT_EQUAL( (size_t)2, queue->queue.size() );
   CPPUNIT_ASSERT_EQUAL( backup, queue->queue.begin()->get() );
+
+  std::cout << "The following warning's do not indicate a failure." << std::endl;
 }
 
@@ -109 +113 @@
 
   // remove op
-  queue->remove(backup, NULL);
+  queue->remove(backup, queue);
   CPPUNIT_ASSERT( queue->queue.begin() == queue->queue.end() );
 }
+
+/** UnitTest whether observer is correctly working.
+ *
+ */
+void OperationQueueTest::observerTest()
+{
+  // sign on to our op
+  AsyncOperation *backup = op; // we need backup as op is NULL'ed
+
+  // place into queue
+  queue->push_back(op, *address);
+
+  // and signal to queue it is done
+  queue->update(backup);
+  backup = NULL;  // should be deleted from this line on
+
+  // check queue is now empty
+  CPPUNIT_ASSERT( queue->queue.begin() == queue->queue.end() );
+}

src/Fragmentation/Automation/unittests/OperationQueueUnitTest.hpp

@@ -32 +32 @@
     CPPUNIT_TEST ( removeTest );
     CPPUNIT_TEST ( findTest );
+    CPPUNIT_TEST ( observerTest );
     CPPUNIT_TEST_SUITE_END();
 
@@ -40 +41 @@
       void push_backTest();
       void removeTest();
+      void observerTest();
 
 private: