Changeset 0af22d for src/UIElements

Timestamp:

Feb 14, 2016, 12:34:26 PM (9 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:

393342

Parents:

b43585

git-author:

Frederik Heber <heber@…> (12/30/15 14:28:53)

git-committer:

Frederik Heber <heber@…> (02/14/16 12:34:26)

Message:

FIX: ObservedValuesContainer uses deque for internal observed values.

• it may happen that an atom is created before the _visual representation_ got destroyed (and hence it's QtObserved... would be destroyed). In that case the QtObservedInstanceBoard fails with an assertion.
• Now, we use a deque. At the front end, we have all the observedvalues that have not yet been deleted, on the back end we have the observedvalues to the currently active instance.
• removed unused getRefCount().

Location:

src/UIElements/Qt4/InstanceBoard

Files:

• ObservedValuesContainer.hpp (modified) (4 diffs)
• ObservedValuesContainer_impl.hpp (modified) (9 diffs)
• QtObservedInstanceBoard.cpp (modified) (2 diffs)

src/UIElements/Qt4/InstanceBoard/ObservedValuesContainer.hpp

@@ -17 +17 @@
 #include "ObservedValue_types.hpp"
 
+#include <deque>
 #include <map>
 #include <string>
@@ -92 +93 @@
 
 private:
-  typedef std::pair<typename T::ptr, size_t> RefCountedObservedValues_t;
-  typedef std::map<id, RefCountedObservedValues_t> CountedObservedValues_t;
+  /** \note CountedObservedValues_t needs to contain a list in the second argument
+   * as the ObservedValuesContainer may fall behind when a single atom is created
+   * and destroyed a number of times in a row (e.g. in the undo/redo cases). This
+   * problem is inherent because on the one hand we keep the QtObservedAtom alive
+   * till the last moment, i.e. till the GUI does not need it anymore where the
+   * original instance may long have been removed from the World. On the other hand
+   * we instantiate the e.g. QtObservedAtom as soon as the observed atom is created.
+   */
+
+  typedef std::deque<std::pair<typename T::ptr, size_t> > RefCountedObservedValues_t;
+  typedef std::map<id, RefCountedObservedValues_t > CountedObservedValues_t;
   //!> internal vector of observed values
   CountedObservedValues_t ObservedValues;
@@ -154 +164 @@
    * \param _id identifier of instance associated with observed values
    * \param _obsvalues vector of observed values of instance
-   * \return true - insertion successful, false - else
    */
-  bool insert(const id _id, const typename T::ptr &_obsvalues);
+  void insert(const id _id, const typename T::ptr &_obsvalues);
 
   /** Use to change the identifier associated with a vector of observed values.
@@ -165 +174 @@
    */
   bool changeIdentifier(const id _oldid, const id _newid);
-
-  /** Returns the number of reference delivered for this instance identified by \a _id.
-   *
-   * \param _id identifier of instance
-   * \return reference count
-   */
-  size_t getRefCount(const id _id) const;
 
   /** Checks whether a vector of observed values of an instance  identified by \a _id

src/UIElements/Qt4/InstanceBoard/ObservedValuesContainer_impl.hpp

@@ -33 +33 @@
 {
   for (typename CountedObservedValues_t::iterator iter = ObservedValues.begin();
-      iter != ObservedValues.end(); ++iter)
-    iter->second.first->noteBoardIsGone();
+      iter != ObservedValues.end(); ++iter) {
+    ASSERT( !iter->second.empty(),
+        "~ObservedValuesContainer() of "+NameOfType+" "+toString(iter->first)
+        +" has an empty list in ObservedValues.");
+    for (typename RefCountedObservedValues_t::iterator listiter = iter->second.begin();
+        listiter != iter->second.end(); ++listiter) {
+      listiter->first->noteBoardIsGone();
+    }
+  }
 }
 
@@ -44 +51 @@
       "ObservedValuesContainer::getObservedValues() - no observed values present for "
       +NameOfType+" "+toString(_id));
-  const typename T::ptr &obsvalues = iter->second.first;
+  ASSERT( !iter->second.empty(),
+      "ObservedValuesContainer<T,id>::get() of "+NameOfType+" "+toString(_id)
+      +" has an empty list in ObservedValues.");
+  const typename T::ptr &obsvalues = iter->second.back().first;
 
   return obsvalues;
@@ -59 +69 @@
       "ObservedValuesContainer<T,id>::markObservedValuesAsConnected() - Observed value of "
       +NameOfType+" "+toString(_id)+" is not present yet.");
-  ++(iter->second.second);
+  ASSERT( !iter->second.empty(),
+      "ObservedValuesContainer<T,id>::markObservedValuesAsConnected() of "+NameOfType
+      +" "+toString(_id)+" has an empty list in ObservedValues.");
+  ++(iter->second.back().second);
 }
 
@@ -67 +80 @@
 {
   typename CountedObservedValues_t::const_iterator iter = ObservedValues.find(_id);
-  return ((iter != ObservedValues.end()) && (iter->second.second == 0));
+  ASSERT( !iter->second.empty(),
+      "ObservedValuesContainer<T,id>::checkRefCount() of "+NameOfType
+      +" "+toString(_id)+" has an empty list in ObservedValues.");
+  return ((iter != ObservedValues.end()) && (iter->second.front().second == 0));
 }
 
@@ -80 +96 @@
       "ObservedValuesContainer<T,id>::markObservedValuesAsDisconnected() - Observed value of "
       +NameOfType+" "+toString(_id)+" is not present yet.");
-  ASSERT (iter->second.second != 0,
+  ASSERT( !iter->second.empty(),
+      "ObservedValuesContainer<T,id>::markObservedValuesAsDisconnected() of "+NameOfType
+      +" "+toString(_id)+" has an empty list in ObservedValues.");
+  ASSERT (iter->second.front().second != 0,
       "ObservedValuesContainer<T,id>::markObservedValuesAsDisconnected() - Observed value of "
       +NameOfType+" "+toString(_id)+" is already signOff() from all.");
-  --(iter->second.second);
+  --(iter->second.front().second);
 
   if (checkRefCount(_id) && checksubjectKilled(_id) && checkMarkedForErase(_id))
@@ -124 +143 @@
   onDestroy(_id);
   subjectKilledCount.erase(_id);
-  ObservedValues.erase(_id);
+  typename CountedObservedValues_t::iterator iter = ObservedValues.find(_id);
+  ASSERT( !iter->second.empty(),
+      "ObservedValuesContainer<T,id>::removeObservedValues() of "+NameOfType
+      +" for "+toString(_id)+" has an empty list in ObservedValues.");
+  if (iter->second.size() == 1)
+    ObservedValues.erase(iter);
+  else {
+    //if more than one, erase always the first one
+    iter->second.pop_front();
+  }
   MarkedForErase.erase(_id);
 }
@@ -150 +178 @@
 
 template <class T, typename id>
-bool ObservedValuesContainer<T,id>::insert(const id _id, const typename T::ptr &_obsvalues)
+void ObservedValuesContainer<T,id>::insert(const id _id, const typename T::ptr &_obsvalues)
 {
   std::pair<typename CountedObservedValues_t::iterator, bool> inserter =
       ObservedValues.insert(
-          std::make_pair( _id, std::make_pair(_obsvalues,0) ) );
+          std::make_pair( _id, RefCountedObservedValues_t(1,std::make_pair(_obsvalues,0)) ) );
+  if (!inserter.second) {
+    // already an entry present? add to deque
+    inserter.first->second.push_back( std::make_pair(_obsvalues,0) );
+  }
   _obsvalues->activateObserver();
-  return inserter.second;
 }
 
@@ -174 +205 @@
   if (status) {
     {
+      // TODO: Actually, we need to think whether we do not have to to split the
+      // deque in two parts: the last entry having the newid, while all other
+      // ones retain the old one until they get removed. But we need to check
+      // whether changing ids "there" is possible when the QtObserved... is under
+      // removal.
       RefCountedObservedValues_t obsvalues = Colditer->second;
       ObservedValues.erase(Colditer);
@@ -193 +229 @@
 
 template <class T, typename id>
-size_t ObservedValuesContainer<T,id>::getRefCount(const id _id) const
-{
-  typename CountedObservedValues_t::const_iterator iter = ObservedValues.find(_id);
-  return iter->second.second;
-}
-
-template <class T, typename id>
 bool ObservedValuesContainer<T,id>::isPresent(const id _id) const
 {

src/UIElements/Qt4/InstanceBoard/QtObservedInstanceBoard.cpp

@@ -159 +159 @@
               moleculeSubjectKilled);
           QtObservedMolecule::ptr observedmolecule(new QtObservedMolecule(ObservedValues, *this));
-#ifndef NDEBUG
-          bool status =
-#endif
-              moleculeObservedValues.insert(_id, observedmolecule);
-          ASSERT( status,
-              "QtObservedInstanceBoard::recieveNotification() - could not insert ObservedMolecule for"
-              +toString(_id)+".");
+          moleculeObservedValues.insert(_id, observedmolecule);
           // we need to check for index changes
           LOG(3, "DEBUG: InformationBoard signOn()s to molecule " << _id);
@@ -207 +201 @@
               atomSubjectKilled);
           QtObservedAtom::ptr observedatom(new QtObservedAtom(ObservedValues, *this));
-#ifndef NDEBUG
-          bool status  =
-#endif
-              atomObservedValues.insert(_id, observedatom);
-          ASSERT( status,
-              "QtObservedInstanceBoard::recieveNotification() - could not insert ObservedValues for"
-              +toString(_id)+".");
+          atomObservedValues.insert(_id, observedatom);
           // we need to check for index changes
           LOG(3, "DEBUG: InformationBoard signOn()s to atom " << _id);