Changeset d25bec for src/documentation/constructs

Timestamp:

Apr 6, 2012, 11:46:15 AM (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:

6a3c83

Parents:

006e1e

git-author:

Frederik Heber <heber@…> (04/06/12 09:48:08)

git-committer:

Frederik Heber <heber@…> (04/06/12 11:46:15)

Message:

Cleaned the structure of Observers, i.e. what they report.

• The boundaries between who reports on what are somewhat unclear right now, this commits fixes it and installs clear responsibilities for each of the major observer entities.
• DOCU: Added section on observer construct on who reports on what.
• FIX: Removed AtomPositionChanged, AtomChanged, and MoleculeChanged (unused) channels in World.

File:

• src/documentation/constructs/observers_observables.dox (modified) (1 diff)

src/documentation/constructs/observers_observables.dox

@@ -61 +61 @@
  * changed!
  *
+ * \section observers-where Who observes what?
+ *
+ * Where to look for a specific update is very important. Hence, we list here
+ * all (major) Observables and what exactly they report in their channels:
+ *  -# \ref World: Gives updates on insertion or removal of atoms and molecules.
+ *     It does not tell whether the inner state of either has changed.
+ *  -# \ref atom: Gives updates on changes to inner state of an atom, i.e.
+ *    -# bonds
+ *    -# element
+ *    -# position
+ *    It does not tell when e.g. it is associated to another molecule.
+ *  -# \ref AtomObserver: Gives updates on changes occuring in any atom. It
+ *     acts as a relay that observes all atoms at once and gives notice when
+ *     a single one has changed. It does not tell when a new has arrived or
+ *     one has been removed.
+ *  -# \ref molecule: Gives updates on changes occuring in its internal state,
+ *     e.g. atoms being inserted or removed. It does not tell when atoms themself
+ *     change.
+ *  -# \ref Box: Gives updates on changes of its box matrix or boundary
+ *     conditions.
+ *
+ * It should be adhered to these Does and Don'ts strictly. Each of these entities
+ * can only report about stuff it knows about. The World controls insertion and
+ * removal, hence its updates are concerned with these only!
+ *
+ *
  * \section observers-world Observers and the World
  *