Changeset e4b2f6 for src

Timestamp:

Apr 21, 2011, 11:57:28 AM (14 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:

ec098d

Parents:

13799e

Message:

Added Action::help().

• Action::help() returns a string that enlists all of its options including type of argument and default values. This will be used by HelpAction.

Location:

src/Actions

Files:

• Action.cpp (modified) (2 diffs)
• Action.hpp (modified) (1 diff)

src/Actions/Action.cpp

@@ -21 +21 @@
 
 #include <iostream>
+#include <sstream>
 #include <string>
 
@@ -105 +106 @@
 }
 
+const std::string Action::help() const
+{
+  std::stringstream outputstream;
+  outputstream << "Description for Action '" << getName() << "': " << Traits.getDescription()
+      << std::endl;
+  if (!Traits.hasOption(getName())) {
+    outputstream << "\tNote that this Action does not take an argument." << std::endl;
+  }
+  outputstream << "Options available for action '" << getName() << "':" << std::endl;
+  for (ActionTraits::options_const_iterator iter = Traits.getBeginIter();
+      iter != Traits.getEndIter();
+      ++iter) {
+    outputstream << "Option '" << iter->first << "':" << std::endl;
+    outputstream << "\tDescription: " << iter->second->getDescription() << "." << std::endl;
+    outputstream << "\tArgument's type: " << iter->second->getTypeName() << "." << std::endl;
+    outputstream << "\tDefault value: ";
+    if (iter->second->hasDefaultValue()) {
+      outputstream << "Yes, is '" << iter->second->getDefaultValue() << "'";
+    } else {
+      outputstream << "None";
+    }
+    outputstream << "." << std::endl;
+  }
+
+  return outputstream.str();
+}
+
 void Action::removeStaticStateEntities()
 {

src/Actions/Action.hpp

@@ -386 +386 @@
 
   /**
+   * returns a detailed help message.
+   */
+  const std::string help() const;
+
+  /**
    * Traits resemble all necessary information that "surrounds" an action, such as
    * its name (for ActionRegistry and as ref from string to instance and vice versa),