source: src/Actions/OptionTrait.cpp@ 361805

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 361805 was 0aa122, checked in by Frederik Heber <heber@…>, 13 years ago

Updated all source files's copyright note to current year 2012.

  • Property mode set to 100644
File size: 4.3 KB
Line 
1/*
2 * Project: MoleCuilder
3 * Description: creates and alters molecular systems
4 * Copyright (C) 2010-2012 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 "CodePatterns/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
30using namespace MoleCuilder;
31
32/** Constructor for class OptionTrait.
33 * note that OptionTrait automatically registers with OptionRegistry.
34 * \param &_token name of option
35 * \param &_type type of option
36 * \param &_description description of what the option is for
37 * \param &_defaultvalue default value, empty string if none
38 * \param &_shortform short form to access option on CommmandLineUI, empty if none
39 * \param *_instance type to be stored in this OptionTrait.
40 */
41OptionTrait::OptionTrait(const std::string &_token, std::type_info const * const _type, const std::string &_description, const std::string &_defaultvalue, const std::string &_shortform) :
42 Token(_token),
43 InternalType(_type),
44 Description(_description),
45 DefaultValue(_defaultvalue),
46 ShortForm(_shortform)
47{
48 //std::cout << "OptionTrait::OptionTrait() on instance " << this << " with " << getName() << ", type " << getTypeName() << " and description " << getDescription() << std::endl;
49}
50
51/** Destructor for class OptionTrait.
52 *
53 */
54OptionTrait::~OptionTrait()
55{
56 //std::cout << "OptionTrait::~OptionTrait() on instance " << this << " with name " << getName() << " called." << std::endl;
57}
58
59/** Returns Current Value for this ActionTrait.
60 * \return OptionTrait::CurrentValue as std::string
61 */
62const std::string& OptionTrait::getDefaultValue() const
63{
64 return DefaultValue;
65}
66
67/** Returns Description for this ActionTrait.
68 * \return OptionTrait::Description as std::string
69 */
70const std::string& OptionTrait::getDescription() const
71{
72 return Description;
73}
74
75/** Specific Getter for a ActionTrait::ShortForm.
76 * If action has a short for, then combination is as "Token,ShortForm" (this is
77 * the desired format for boost::program_options). If no short form exists in the map,
78 * just Token will be returned
79 * Note that we assert when action does not exist in CommandLineParser::DescriptionMap.
80 * \return ActionTrait::Token,ActionTrait::ShortForm or Description of the action
81 */
82const std::string OptionTrait::getKeyAndShortForm() const
83{
84 std::stringstream output;
85 output << Token;
86 if (hasShortForm())
87 output << "," << ShortForm;
88 return output.str();
89}
90
91
92/** Returns ShortForm for this OptionTrait.
93 * \return OptionTrait::ShortForm as std::string
94 */
95const std::string& OptionTrait::getShortForm() const
96{
97 return ShortForm;
98}
99
100/** Returns Type for this OptionTrait.
101 * \return OptionTrait::InternalType as std::type_info reference
102 */
103const std::type_info * const OptionTrait::getType() const
104{
105 return InternalType;
106}
107
108/** Returns Name of the Type for this OptionTrait.
109 * \return OptionTrait::InternalType->name()
110 */
111const std::string OptionTrait::getTypeName() const
112{
113 return InternalType->name();
114}
115
116/** States whether DefaultValue is present or not.
117 * \return true - DefaultValue unequal to empty string present.
118 */
119bool OptionTrait::hasDefaultValue() const
120{
121 return (!DefaultValue.empty());
122}
123
124/** States whether ShortForm is present or not.
125 * \return true - ShortForm unequal to empty string present.
126 */
127bool OptionTrait::hasShortForm() const
128{
129 return (!ShortForm.empty());
130}
131
132/** Returns token of the option.
133 * \return name/token of option
134 */
135const std::string& OptionTrait::getName() const
136{
137 return Token;
138}
139
140/** Sets the short form to the given value.
141 * \param &_shortform new short form
142 */
143void OptionTrait::setShortForm(const std::string _shortform)
144{
145 ShortForm = _shortform;
146}
147
148/** Output operator for OptionTrait.
149 *
150 * \param &out output stream to print to.
151 */
152std::ostream& operator<<(std::ostream &out, const OptionTrait &t)
153{
154 out << "OptionTrait(" << &t << "): Name(" << t.getName() << ")";
155 out << ", Type(" << t.getTypeName() << ")";
156 out << ", Default(" << t.getDefaultValue() << ")";
157 out << ", ShortForm(" << t.getShortForm() << ")";
158 out << "." << std::endl;
159 return out;
160}
Note: See TracBrowser for help on using the repository browser.