source: src/Actions/OptionTrait.cpp@ c38826

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 c38826 was c38826, checked in by Frederik Heber <heber@…>, 14 years ago

Removed debug statements in ..Traits() constructors.

  • Property mode set to 100644
File size: 4.2 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 * OptionTrait.cpp
10 *
11 * Created on: Oct 27, 2010
12 * Author: heber
13 */
14
15// include config.h
16#ifdef HAVE_CONFIG_H
17#include <config.h>
18#endif
19
20#include "Helpers/MemDebug.hpp"
21
22#include <iostream>
23#include <typeinfo>
24
25#include <boost/shared_ptr.hpp>
26
27#include "Actions/OptionRegistry.hpp"
28#include "Actions/OptionTrait.hpp"
29
30/** Constructor for class OptionTrait.
31 * note that OptionTrait automatically registers with OptionRegistry.
32 * \param &_token name of option
33 * \param &_type type of option
34 * \param &_description description of what the option is for
35 * \param &_defaultvalue default value, empty string if none
36 * \param &_shortform short form to access option on CommmandLineUI, empty if none
37 * \param *_instance type to be stored in this OptionTrait.
38 */
39OptionTrait::OptionTrait(const std::string &_token, std::type_info const * const _type, const std::string _description, const std::string _defaultvalue, const std::string _shortform) :
40 Token(_token),
41 InternalType(_type),
42 Description(_description),
43 DefaultValue(_defaultvalue),
44 ShortForm(_shortform)
45{
46 //std::cout << "OptionTrait::OptionTrait() with " << getName() << ", type " << getTypeName() << " and description " << getDescription() << std::endl;
47}
48
49/** Copy constructor for class OptionTrait.
50 * note that OptionTrait automatically registers with OptionRegistry.
51 * \param &_option reference of option to copy
52 * \param *_instance type to be stored in this OptionTrait.
53 */
54OptionTrait::OptionTrait(const OptionTrait &_option) :
55 Token(_option.getName()),
56 InternalType(_option.getType()),
57 Description(_option.getDescription()),
58 DefaultValue(_option.getDefaultValue()),
59 ShortForm(_option.getShortForm())
60{}
61
62/** Destructor for class OptionTrait.
63 *
64 */
65OptionTrait::~OptionTrait()
66{}
67
68/** Returns Current Value for this ActionTrait.
69 * \return OptionTrait::CurrentValue as std::string
70 */
71const std::string& OptionTrait::getDefaultValue() const
72{
73 return DefaultValue;
74}
75
76/** Returns Description for this ActionTrait.
77 * \return OptionTrait::Description as std::string
78 */
79const std::string& OptionTrait::getDescription() const
80{
81 return Description;
82}
83
84/** Specific Getter for a ActionTrait::ShortForm.
85 * If action has a short for, then combination is as "Token,ShortForm" (this is
86 * the desired format for boost::program_options). If no short form exists in the map,
87 * just Token will be returned
88 * Note that we assert when action does not exist in CommandLineParser::DescriptionMap.
89 * \return ActionTrait::Token,ActionTrait::ShortForm or Description of the action
90 */
91const std::string OptionTrait::getKeyAndShortForm() const
92{
93 std::stringstream output;
94 output << Token;
95 if (hasShortForm())
96 output << "," << ShortForm;
97 return output.str();
98}
99
100
101/** Returns ShortForm for this OptionTrait.
102 * \return OptionTrait::ShortForm as std::string
103 */
104const std::string& OptionTrait::getShortForm() const
105{
106 return ShortForm;
107}
108
109/** Returns Type for this OptionTrait.
110 * \return OptionTrait::InternalType as std::type_info reference
111 */
112const std::type_info * const OptionTrait::getType() const
113{
114 return InternalType;
115}
116
117/** Returns Name of the Type for this OptionTrait.
118 * \return OptionTrait::InternalType->name()
119 */
120const std::string OptionTrait::getTypeName() const
121{
122 return InternalType->name();
123}
124
125/** States whether DefaultValue is present or not.
126 * \return true - DefaultValue unequal to empty string present.
127 */
128bool OptionTrait::hasDefaultValue() const
129{
130 return (!DefaultValue.empty());
131}
132
133/** States whether ShortForm is present or not.
134 * \return true - ShortForm unequal to empty string present.
135 */
136bool OptionTrait::hasShortForm() const
137{
138 return (!ShortForm.empty());
139}
140
141/** Returns token of the option.
142 * \return name/token of option
143 */
144const std::string& OptionTrait::getName() const
145{
146 return Token;
147}
148
149/** Sets the short form to the given value.
150 * \param &_shortform new short form
151 */
152void OptionTrait::setShortForm(const std::string _shortform)
153{
154 ShortForm = _shortform;
155}
Note: See TracBrowser for help on using the repository browser.