Changeset dac853c for src

Timestamp:

Apr 21, 2011, 1:51:13 PM (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:

50228e

Parents:

406bb5

git-author:

Frederik Heber <heber@…> (04/21/11 12:03:37)

git-committer:

Frederik Heber <heber@…> (04/21/11 13:51:13)

Message:

Rewrote HelpAction.

• is currently only useful to CommandLineParser.
• gives general help and either list of Actions or an Action's help.
• TESTFIX: changed regression test on help as output changed (a lot).

Location:

src/Actions/CommandAction

Files:

• HelpAction.cpp (modified) (2 diffs)
• HelpAction.def (modified) (2 diffs)

src/Actions/CommandAction/HelpAction.cpp

@@ -23 +23 @@
 #include <string>
 
-using namespace std;
+#include "Actions/ActionRegistry.hpp"
+#include "Actions/ActionTraits.hpp"
+#include "Actions/OptionRegistry.hpp"
+#include "Actions/OptionTrait.hpp"
+#include "CodePatterns/Log.hpp"
 
 #include "Actions/CommandAction/HelpAction.hpp"
@@ -34 +38 @@
   // obtain information
   getParametersfromValueStorage();
+
+  // print some general advice
+  std::cout << std::endl << std::endl << "Usage help:" << std::endl;
+  std::cout << "================================================================================" << std::endl;
+  std::cout << "Usage: molecuilder --<action name> [arguments] [--<option1 name> <argument> ...]" << std::endl;
+  std::cout << std::endl;
+  std::cout << "MoleCuilder can do all kinds of measurements and manipulations and it always"  << std::endl;
+  std::cout << "works on files! See action 'input' and 'set-output' on how to specify these." << std::endl;
+  std::cout << std::endl;
+  std::cout << "To get a list of all actions, use " << std::endl;
+  std::cout << "\t'molecuilder --help'." << std::endl;
+  std::cout << "To get all options for a specific action, use " << std::endl;
+  std::cout << "\t'molecuilder --help --actionname \"<actionname>\"'." << std::endl;
+  std::cout << std::endl;
+  std::cout << "Arguments are given in the following (peculiar) ways:" << std::endl;
+  std::cout << "\t - Boolean: give as 0 (false) or 1 (true)." << std::endl;
+  std::cout << "\t - Integer: give as e.g. 17" << std::endl;
+  std::cout << "\t - Double: give as e.g. 0.5346" << std::endl;
+  std::cout << "\t - String: give as e.g. \"test\"" << std::endl;
+  std::cout << "\t - List/vector of strings: gives as \"first\" \"second\" \"third\"." << std::endl;
+  std::cout << "\t - Vector: give as \"x,y,z\", i.e. its 3 components." << std::endl;
+  std::cout << "\t - Domain: give as \"xx,xy,xz,yy,yz,zz\", i.e. symmetric 3x3 matrix." << std::endl;
+  std::cout << "\t - Path/filename: give as \"<path/filename>\"." << std::endl;
+  std::cout << "================================================================================" << std::endl;
+  std::cout << std::endl;
+  // print list of actions or its options
+  if (params.actionname == "none") {
+    // print list of all Actions
+    std::cout << "Here is a list of all available Actions:" << std::endl;
+    for(ActionRegistry::const_iterator iter = ActionRegistry::getInstance().getBeginIter();
+        iter != ActionRegistry::getInstance().getEndIter();
+        ++iter) {
+      const Action *instance = iter->second;
+      std::cout << "'" << iter->first << "': \t "
+          << instance->Traits.getDescription() << std::endl;
+    }
+  } else {
+    // retrieve command from Registry and print its help
+    if (ActionRegistry::getInstance().isActionPresentByName(params.actionname)) {
+      const Action *instance = ActionRegistry::getInstance().getActionByName(params.actionname);
+      // else give description of Action and its option value if present
+      std::cout << instance->help();
+      std::cout << std::endl;
+      std::cout << std::endl;
+    } else {
+      ELOG(1, "No action is known by the name " << params.actionname << ".");
+      return Action::failure;
+    }
+
+  }
 
   return Action::success;

src/Actions/CommandAction/HelpAction.def

@@ -12 +12 @@
 // ValueStorage by the token "Z" -> first column: int, Z, "Z"
 // "undefine" if no parameters are required, use (NODEFAULT) for each (undefined) default value
-#undef paramtypes
-#undef paramtokens
-#undef paramdescriptions
-#undef paramdefaults
-#undef paramreferences
+#define paramtypes (std::string)
+#define paramtokens ("actionname")
+#define paramdescriptions ("Name of an action whose option list is then given")
+#define paramdefaults ("none")
+#define paramreferences (actionname)
 
 #undef statetypes
@@ -30 +30 @@
 
 // finally the information stored in the ActionTrait specialization
-#define DESCRIPTION "help screen"
+#define DESCRIPTION "prints help and available actions, or an action's options"
 #define SHORTFORM "h"