Ignore:
Timestamp:
May 20, 2014, 9:14:56 AM (11 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:
6029a6
Parents:
74459a
git-author:
Frederik Heber <heber@…> (03/20/14 17:23:35)
git-committer:
Frederik Heber <heber@…> (05/20/14 09:14:56)
Message:

Enhanced documentation significantly.

  • went through all of the constructs and updated each.
  • enhanced documentation ofr Fragmentation::FragmentMolecule().
File:
1 edited

Legend:

Unmodified
Added
Removed

  • src/documentation/constructs/actions.dox

    r74459a rcaece4  
    33 * Description: creates and alters molecular systems
    44 * Copyright (C)  2010 University of Bonn. All rights reserved.
     5 * Copyright (C)  2014 Frederik Heber. All rights reserved.
    56 * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
    67 */
    … …  
    2627 *  the Action does.
    2728 *
    28  *  Each Action has thus three types of functionality: do, undo, and redo.
     29 *  Each Action has thus three types of functionality: do, undo, and redo. And
     30 *  each action has a unique \a token: a name without white space that is
     31 *  descriptive.
    2932 *
    30  *  The ActionRegistry contains a prototype of each Action under its token
    31  *  such that an instance can be retrieved by knowing this token.
     33 *  The ActionRegistry contains a prototype of each Action under its token.
     34 *  If an Action is requested via its known token from the ActionQueue
     35 *  (that contains the ActionRegistry), this prototype is cloned and added to the
     36 *  queue.
    3237 *
    33  *  Each Action can contain multiple \ref parameters in its specific ActionParameters
    34  *  structure that represent the options. Executing call() first fills a dialog
    35  *  with \ref queries, one for each option. The UI then tries to obtain the
    36  *  values from the user. Depending on the type of the UI in use that could mean
    37  *  parsing stored command line parameters or displaying a real dialog box with widgets.
     38 *  Each Action can contain multiple \ref parameters in its specific
     39 *  ActionParameters structure that represent the options. Executing call() first
     40 *  fills a dialog with \ref queries, one for each option. The UI then tries to
     41 *  obtain the values from the user. Depending on the type of the UI in use that
     42 *  could mean parsing stored command line parameters or displaying a real dialog
     43 *  box with widgets.
    3844 *
    3945 *  Also there is a regression test (\ref regression-test) for each Action to
    4046 *  check that it always behaves the same no matter how much the code
    41  *  implementing actually has changed.
     47 *  implementing actually has changed. In most cases also for testing undo and
     48 *  redo.
    4249 *
    4350 * \section actions-add To add a new action ...
    … …  
    5360 *
    5461 * The central points of Actions is that they can be undone and redone. This
    55  * has to be implemented in two more functions beside the "do".
     62 * has to be implemented in two more functions beside the "do" in performCall().
    5663 *
    5764 * Note that undoing means to get everything back to its original state and by whatever
    … …  
    6168 * E.g. if your Action creates some new atoms, store their info as \ref AtomicInfo.
    6269 * Then, undo can simply delete the newly created atoms and redo can quickly re-
    63  * create them in the state they have been before.
     70 * create them in the state they have been before. Types required for storage are
     71 * contained in the Action's state and are filled during performCall(). Undo and
     72 * redo both get access to this state and may use the information as described.
    6473 *
    6574 * Have a look at \ref UndoRedoHelpers.hpp for some helper functions on this.
    … …  
    7281 *
    7382 *
    74  *  \date 2013-02-07
     83 *  \date 2014-03-10
    7584 *
    7685 */
Note: See TracChangeset for help on using the changeset viewer.