source: src/Actions/CommandAction/HelpAction.cpp@ 838cd0

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
Last change on this file since 838cd0 was 416f10, checked in by Frederik Heber <heber@…>, 13 years ago

FIX: help string on domain is wrong.

  • CommandHelpAction() gives components of symmetric matrix for domain in wrong order (upper now lower triagonal).
  • Property mode set to 100644
File size: 4.1 KB
Line 
1/*
2 * Project: MoleCuilder
3 * Description: creates and alters molecular systems
4 * Copyright (C) 2010 University of Bonn. All rights reserved.
5 * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
6 */
7
8/*
9 * HelpAction.cpp
10 *
11 * Created on: May 8, 2010
12 * Author: heber
13 */
14
15// include config.h
16#ifdef HAVE_CONFIG_H
17#include <config.h>
18#endif
19
20#include "CodePatterns/MemDebug.hpp"
21
22#include <iostream>
23#include <string>
24
25#include "Actions/ActionRegistry.hpp"
26#include "Actions/ActionTraits.hpp"
27#include "Actions/OptionRegistry.hpp"
28#include "Actions/OptionTrait.hpp"
29#include "CodePatterns/Log.hpp"
30
31#include "Actions/CommandAction/HelpAction.hpp"
32
33// and construct the stuff
34#include "HelpAction.def"
35#include "Action_impl_pre.hpp"
36/** =========== define the function ====================== */
37Action::state_ptr CommandHelpAction::performCall() {
38 // obtain information
39 getParametersfromValueStorage();
40
41 // print some general advice
42 std::cout << std::endl << std::endl << "Usage help:" << std::endl;
43 std::cout << "================================================================================" << std::endl;
44 std::cout << "Usage: molecuilder --<action name> [arguments] [--<option1 name> <argument> ...]" << std::endl;
45 std::cout << std::endl;
46 std::cout << "MoleCuilder can do all kinds of measurements and manipulations and it always" << std::endl;
47 std::cout << "works on files! See action 'input' and 'set-output' on how to specify these." << std::endl;
48 std::cout << std::endl;
49 std::cout << "To get a list of all actions, use " << std::endl;
50 std::cout << "\t'molecuilder --help'." << std::endl;
51 std::cout << "To get all options for a specific action, use " << std::endl;
52 std::cout << "\t'molecuilder --help --actionname \"<actionname>\"'." << std::endl;
53 std::cout << std::endl;
54 std::cout << "Arguments are given in the following (peculiar) ways:" << std::endl;
55 std::cout << "\t - Boolean: give as 0 (false) or 1 (true)." << std::endl;
56 std::cout << "\t - Integer: give as e.g. 17" << std::endl;
57 std::cout << "\t - Double: give as e.g. 0.5346" << std::endl;
58 std::cout << "\t - String: give as e.g. \"test\"" << std::endl;
59 std::cout << "\t - List/vector of strings: gives as \"first\" \"second\" \"third\"." << std::endl;
60 std::cout << "\t - Vector: give as \"x,y,z\", i.e. its 3 components." << std::endl;
61 std::cout << "\t - Domain: give as \"xx,yx,yy,zx,zy,zz\", i.e. symmetric 3x3 matrix." << std::endl;
62 std::cout << "\t - Path/filename: give as \"<path/filename>\"." << std::endl;
63 std::cout << "================================================================================" << std::endl;
64 std::cout << std::endl;
65 // print list of actions or its options
66 if (params.actionname == "none") {
67 // print list of all Actions
68 std::cout << "Here is a list of all available Actions:" << std::endl;
69 for(ActionRegistry::const_iterator iter = ActionRegistry::getInstance().getBeginIter();
70 iter != ActionRegistry::getInstance().getEndIter();
71 ++iter) {
72 const Action *instance = iter->second;
73 std::cout << "'" << iter->first << "': \t "
74 << instance->Traits.getDescription() << std::endl;
75 }
76 } else {
77 // retrieve command from Registry and print its help
78 if (ActionRegistry::getInstance().isActionPresentByName(params.actionname)) {
79 const Action *instance = ActionRegistry::getInstance().getActionByName(params.actionname);
80 // else give description of Action and its option value if present
81 std::cout << instance->help();
82 std::cout << std::endl;
83 std::cout << std::endl;
84 } else {
85 ELOG(1, "No action is known by the name " << params.actionname << ".");
86 return Action::failure;
87 }
88
89 }
90
91 return Action::success;
92}
93
94Action::state_ptr CommandHelpAction::performUndo(Action::state_ptr _state) {
95 return Action::success;
96}
97
98Action::state_ptr CommandHelpAction::performRedo(Action::state_ptr _state){
99 return Action::success;
100}
101
102bool CommandHelpAction::canUndo() {
103 return true;
104}
105
106bool CommandHelpAction::shouldUndo() {
107 return false;
108}
109/** =========== end of function ====================== */
Note: See TracBrowser for help on using the repository browser.