Changeset eee1b7 for src/documentation/constructs/actions.dox

Timestamp:

Feb 24, 2013, 12:59:34 PM (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:

dd966f

Parents:

c91572

git-author:

Frederik Heber <heber@…> (02/19/13 12:51:53)

git-committer:

Frederik Heber <heber@…> (02/24/13 12:59:34)

Message:

DOCU: Documentation on ShapeRegistry, QtUI changes, validators, and parameters.

File:

• src/documentation/constructs/actions.dox (modified) (3 diffs)

src/documentation/constructs/actions.dox

@@ -22 +22 @@
  *  have to create three files of which only one actually contains more than a
  *  few lines, namely the code of the Action itself.
+ *  Each Action also derives a specific ActionState and ActionParameters for
+ *  containing the undo/redo state information and the parameters steering what
+ *  the Action does.
  *
- *  Each Action has thus three types of functionalty: do, undo, and redo.
+ *  Each Action has thus three types of functionality: do, undo, and redo.
  *
  *  The ActionRegistry contains a prototype of each Action under its token
  *  such that an instance can be retrieved by knowing this token.
  *
- *  Each Action obtains its options from a central ValueStorage such that
- *  they are independent of where the option originated from: a command line
- *  parameter, a value entered in a graphical dialog or given via the keyboard
- *  in a terminal. That's why each begins with a function call to
- *  getParametersfromValueStorage() to fill its internal Action::params
- *  structure.
+ *  Each Action can contain multiple \ref parameters in its specific ActionParameters
+ *  structure that represent the options. Executing call() first fills a dialog
+ *  with \ref queries, one for each option. The UI then tries to obtain the
+ *  values from the user. Depending on the type of the UI in use that could mean
+ *  parsing stored command line parameters or displaying a real dialog box with widgets.
  *
  *  Also there is a regression test (\ref regression-test) for each Action to
@@ -53 +55 @@
  * has to be implemented in two more functions beside the "do".
  *
- * Note that undoing means to get everything back to its original state and by
- * whatever means seem appropriate, e.g. just remvoing all inserted atoms.
+ * Note that undoing means to get everything back to its original state and by whatever
+ * means seem appropriate, e.g. remvoing all just inserted atoms.
  * To make this more elaborate it is usually very useful to store extra information
  * in the Action's state such that undo and redo can be accomplished more quickly.
@@ -70 +72 @@
  *
  *
- *  \date 2012-12-04
+ *  \date 2013-02-07
  *
  */