Changeset 9ed706 for src/LinkedCell

Timestamp:

Jan 2, 2012, 1:34:58 PM (13 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:

99f4ee

Parents:

c29915

git-author:

Frederik Heber <heber@…> (12/21/11 18:00:53)

git-committer:

Frederik Heber <heber@…> (01/02/12 13:34:58)

Message:

Implemented counting of active LinkedCell_View instances in static map.

• this will allow us to exchange the models when the domain changes without the user noticing.

Location:

src/LinkedCell

Files:

• LinkedCell_View.cpp (modified) (2 diffs)
• LinkedCell_View.hpp (modified) (3 diffs)
• unittests/LinkedCell_ViewUnitTest.cpp (modified) (1 diff)
• unittests/LinkedCell_ViewUnitTest.hpp (modified) (2 diffs)
• unittests/stubs/LinkedCell_ViewStub.cpp (modified) (1 diff)

src/LinkedCell/LinkedCell_View.cpp

@@ -22 +22 @@
 #include "LinkedCell_View.hpp"
 
+#include <algorithm>
+
+#include "CodePatterns/Assert.hpp"
 #include "CodePatterns/Log.hpp"
 
@@ -32 +35 @@
 using namespace LinkedCell;
 
+// static multimap instance
+LinkedCell_View::ModelInstanceMap LinkedCell_View::RAIIMap;
+
+/** Constructor of class LinkedCell_View.
+ *
+ * We add ourselves to RAIIMap here.
+ */
 LinkedCell_View::LinkedCell_View(const LinkedCell_Model &_LC) :
     LC(_LC)
-{}
+{
+  // add us to RAII counting map
+#ifndef NDEBUG
+  std::pair< ModelInstanceMap::iterator, bool> inserter =
+#endif
+      RAIIMap.insert( this );
+  ASSERT( inserter.second,
+      "LinkedCell_View::LinkedCell_View() - we "+toString(this)+" are already present in RAIIMap.");
+  LOG(1, "INFO: Placing instance "+toString(this)+" into RAIIMap.");
+}
 
+/** Copy Constructor of class LinkedCell_View.
+ *
+ * We add ourselves to RAIIMap here.
+ */
+LinkedCell_View::LinkedCell_View(const LinkedCell_View &_view) :
+    LC(_view.LC)
+{
+  if (this != &_view) {
+    // add us to RAII counting map
+  #ifndef NDEBUG
+    std::pair< ModelInstanceMap::iterator, bool> inserter =
+  #endif
+        RAIIMap.insert( this );
+    ASSERT( inserter.second,
+        "LinkedCell_View::LinkedCell_View(&view) - we "+toString(this)+" are already present in RAIIMap.");
+    LOG(1, "INFO: Placing instance "+toString(this)+" copied from "+toString(&_view)+" into RAIIMap.");
+  }
+}
+
+/** Destructor of class LinkedCell_View.
+ *
+ * We remove ourselves from RAIIMap here.
+ */
 LinkedCell_View::~LinkedCell_View()
 {
+  ModelInstanceMap::iterator iter = RAIIMap.find(this);
+  ASSERT( iter != RAIIMap.end(),
+      "LinkedCell_View::~LinkedCell_View() - there is no instance "
+      +toString(this)+" in RAIIMap.");
+  if (iter != RAIIMap.end()) {
+    RAIIMap.erase(iter);
+    LOG(1, "INFO: Removing instance "+toString(this)+" from RAIIMap.");
+  } else {
+    ELOG(1, "Failed to remove instance "+toString(this)+" from RAIIMap.");
+  }
 }
-
 
 /** Return at least as many points as are inside a sphere of \a radius around \a center.

src/LinkedCell/LinkedCell_View.hpp

@@ -14 +14 @@
 #endif
 
+#include <set>
+
 #include "LinkedCell/types.hpp"
 
+class LinkedCell_ViewTest;
 class TesselPoint;
 class Vector;
@@ -33 +36 @@
   class LinkedCell_View
   {
+    //!> grant unit test access to private parts
+    friend class ::LinkedCell_ViewTest;
   public:
-    LinkedCell_View(const LinkedCell_Model &_LC);
+    LinkedCell_View(const LinkedCell_View &_view);
     ~LinkedCell_View();
 
@@ -40 +45 @@
     LinkedList getPointsInsideSphere(const double radius, const Vector &center) const;
   private:
+    friend class LinkedCell_Controller;
+    // constructing views is allowed for the controller
+    explicit LinkedCell_View(const LinkedCell_Model &_LC);
+
+    // don't allow any view assignments or default cstors
+    LinkedCell_View & operator=(const LinkedCell_View &_view);
+    LinkedCell_View & operator=(LinkedCell_View &_view);
+    LinkedCell_View();
+  private:
+    typedef std::set<LinkedCell_View *> ModelInstanceMap;
+    //!> static map to allow for RAII pattern
+    static ModelInstanceMap RAIIMap;
+    //!> internal reference to the underlying model
     const LinkedCell_Model &LC;
   };

src/LinkedCell/unittests/LinkedCell_ViewUnitTest.cpp

@@ -178 +178 @@
   }
 }
+
+
+LinkedCell::LinkedCell_View returnView(LinkedCell::LinkedCell_View &view)
+{
+  return view;
+}
+
+LinkedCell::LinkedCell_View returnCopiedView(LinkedCell::LinkedCell_View &view)
+{
+  LinkedCell::LinkedCell_View retview(view);
+  return retview;
+}
+
+/** UnitTest on whether counting in RAIIMap works
+ */
+void LinkedCell_ViewTest::RAIIMapTest()
+{
+  CPPUNIT_ASSERT_EQUAL( (size_t)1, LinkedCell::LinkedCell_View::RAIIMap.size() );
+
+  // check that we are present
+  LinkedCell::LinkedCell_View::ModelInstanceMap::iterator iter =
+      LinkedCell::LinkedCell_View::RAIIMap.find(LC);
+  CPPUNIT_ASSERT( iter != LinkedCell::LinkedCell_View::RAIIMap.end() );
+  CPPUNIT_ASSERT( *iter == LC );
+
+  // check that we are the only value present
+  ++iter;
+  CPPUNIT_ASSERT( iter == LinkedCell::LinkedCell_View::RAIIMap.end() );
+
+  // add another view and check that there is not assertion
+  LinkedCell::LinkedCell_View *view = NULL;
+  CPPUNIT_ASSERT_NO_THROW( view = new LinkedCell::LinkedCell_View(*LCImpl) );
+  CPPUNIT_ASSERT_EQUAL( (size_t)2, LinkedCell::LinkedCell_View::RAIIMap.size() );
+  delete view;
+  CPPUNIT_ASSERT_EQUAL( (size_t)1, LinkedCell::LinkedCell_View::RAIIMap.size() );
+
+  // copy current view
+  {
+    LinkedCell::LinkedCell_View view(*LC);
+    CPPUNIT_ASSERT_EQUAL( (size_t)2, LinkedCell::LinkedCell_View::RAIIMap.size() );
+    LinkedCell::LinkedCell_View view2 = *LC;
+    CPPUNIT_ASSERT_EQUAL( (size_t)3, LinkedCell::LinkedCell_View::RAIIMap.size() );
+  }
+  CPPUNIT_ASSERT_EQUAL( (size_t)1, LinkedCell::LinkedCell_View::RAIIMap.size() );
+
+  // with function returning view
+  {
+    LinkedCell::LinkedCell_View view = returnView(*LC);
+    CPPUNIT_ASSERT_EQUAL( (size_t)2, LinkedCell::LinkedCell_View::RAIIMap.size() );
+  }
+  CPPUNIT_ASSERT_EQUAL( (size_t)1, LinkedCell::LinkedCell_View::RAIIMap.size() );
+
+  // with function returning copied view
+  {
+    LinkedCell::LinkedCell_View view = returnCopiedView(*LC);
+    CPPUNIT_ASSERT_EQUAL( (size_t)2, LinkedCell::LinkedCell_View::RAIIMap.size() );
+  }
+  CPPUNIT_ASSERT_EQUAL( (size_t)1, LinkedCell::LinkedCell_View::RAIIMap.size() );
+}
+

src/LinkedCell/unittests/LinkedCell_ViewUnitTest.hpp

@@ -29 +29 @@
     CPPUNIT_TEST ( getAllNeighborsTest );
     CPPUNIT_TEST ( getPointsInsideSphereTest );
+    CPPUNIT_TEST ( RAIIMapTest );
     CPPUNIT_TEST_SUITE_END();
 
@@ -37 +38 @@
       void getAllNeighborsTest();
       void getPointsInsideSphereTest();
+      void RAIIMapTest();
 
 private:

src/LinkedCell/unittests/stubs/LinkedCell_ViewStub.cpp

@@ -28 +28 @@
 {}
 
+LinkedCell_View::LinkedCell_View(const LinkedCell_View &_view) :
+    LC(_view.LC)
+{}
+
 LinkedCell_View::~LinkedCell_View()
 {