1 | /*
|
---|
2 | * Project: MoleCuilder
|
---|
3 | * Description: creates and alters molecular systems
|
---|
4 | * Copyright (C) 2010-2012 University of Bonn. All rights reserved.
|
---|
5 | *
|
---|
6 | *
|
---|
7 | * This file is part of MoleCuilder.
|
---|
8 | *
|
---|
9 | * MoleCuilder is free software: you can redistribute it and/or modify
|
---|
10 | * it under the terms of the GNU General Public License as published by
|
---|
11 | * the Free Software Foundation, either version 2 of the License, or
|
---|
12 | * (at your option) any later version.
|
---|
13 | *
|
---|
14 | * MoleCuilder is distributed in the hope that it will be useful,
|
---|
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
17 | * GNU General Public License for more details.
|
---|
18 | *
|
---|
19 | * You should have received a copy of the GNU General Public License
|
---|
20 | * along with MoleCuilder. If not, see <http://www.gnu.org/licenses/>.
|
---|
21 | */
|
---|
22 |
|
---|
23 | /*
|
---|
24 | * OptionTrait.cpp
|
---|
25 | *
|
---|
26 | * Created on: Oct 27, 2010
|
---|
27 | * Author: heber
|
---|
28 | */
|
---|
29 |
|
---|
30 | // include config.h
|
---|
31 | #ifdef HAVE_CONFIG_H
|
---|
32 | #include <config.h>
|
---|
33 | #endif
|
---|
34 |
|
---|
35 | //#include "CodePatterns/MemDebug.hpp"
|
---|
36 |
|
---|
37 | #include <iostream>
|
---|
38 | #include <typeinfo>
|
---|
39 |
|
---|
40 | #include <boost/shared_ptr.hpp>
|
---|
41 |
|
---|
42 | #include "Actions/OptionRegistry.hpp"
|
---|
43 | #include "Actions/OptionTrait.hpp"
|
---|
44 |
|
---|
45 | using namespace MoleCuilder;
|
---|
46 |
|
---|
47 | /** Constructor for class OptionTrait.
|
---|
48 | * note that OptionTrait automatically registers with OptionRegistry.
|
---|
49 | * \param &_token name of option
|
---|
50 | * \param &_type type of option
|
---|
51 | * \param &_description description of what the option is for
|
---|
52 | * \param &_defaultvalue default value, empty string if none
|
---|
53 | * \param &_shortform short form to access option on CommmandLineUI, empty if none
|
---|
54 | * \param *_instance type to be stored in this OptionTrait.
|
---|
55 | */
|
---|
56 | OptionTrait::OptionTrait(const std::string &_token, std::type_info const * const _type, const std::string &_description, const std::string &_defaultvalue, const std::string &_shortform) :
|
---|
57 | Token(_token),
|
---|
58 | InternalType(_type),
|
---|
59 | Description(_description),
|
---|
60 | DefaultValue(_defaultvalue),
|
---|
61 | ShortForm(_shortform)
|
---|
62 | {
|
---|
63 | //std::cout << "OptionTrait::OptionTrait() on instance " << this << " with " << getName() << ", type " << getTypeName() << " and description " << getDescription() << std::endl;
|
---|
64 | }
|
---|
65 |
|
---|
66 | /** Destructor for class OptionTrait.
|
---|
67 | *
|
---|
68 | */
|
---|
69 | OptionTrait::~OptionTrait()
|
---|
70 | {
|
---|
71 | //std::cout << "OptionTrait::~OptionTrait() on instance " << this << " with name " << getName() << " called." << std::endl;
|
---|
72 | }
|
---|
73 |
|
---|
74 | /** Returns Current Value for this ActionTrait.
|
---|
75 | * \return OptionTrait::CurrentValue as std::string
|
---|
76 | */
|
---|
77 | const std::string& OptionTrait::getDefaultValue() const
|
---|
78 | {
|
---|
79 | return DefaultValue;
|
---|
80 | }
|
---|
81 |
|
---|
82 | /** Returns Description for this ActionTrait.
|
---|
83 | * \return OptionTrait::Description as std::string
|
---|
84 | */
|
---|
85 | const std::string& OptionTrait::getDescription() const
|
---|
86 | {
|
---|
87 | return Description;
|
---|
88 | }
|
---|
89 |
|
---|
90 | /** Specific Getter for a ActionTrait::ShortForm.
|
---|
91 | * If action has a short for, then combination is as "Token,ShortForm" (this is
|
---|
92 | * the desired format for boost::program_options). If no short form exists in the map,
|
---|
93 | * just Token will be returned
|
---|
94 | * Note that we assert when action does not exist in CommandLineParser::DescriptionMap.
|
---|
95 | * \return ActionTrait::Token,ActionTrait::ShortForm or Description of the action
|
---|
96 | */
|
---|
97 | const std::string OptionTrait::getKeyAndShortForm() const
|
---|
98 | {
|
---|
99 | std::stringstream output;
|
---|
100 | output << Token;
|
---|
101 | if (hasShortForm())
|
---|
102 | output << "," << ShortForm;
|
---|
103 | return output.str();
|
---|
104 | }
|
---|
105 |
|
---|
106 |
|
---|
107 | /** Returns ShortForm for this OptionTrait.
|
---|
108 | * \return OptionTrait::ShortForm as std::string
|
---|
109 | */
|
---|
110 | const std::string& OptionTrait::getShortForm() const
|
---|
111 | {
|
---|
112 | return ShortForm;
|
---|
113 | }
|
---|
114 |
|
---|
115 | /** Returns Type for this OptionTrait.
|
---|
116 | * \return OptionTrait::InternalType as std::type_info reference
|
---|
117 | */
|
---|
118 | const std::type_info * const OptionTrait::getType() const
|
---|
119 | {
|
---|
120 | return InternalType;
|
---|
121 | }
|
---|
122 |
|
---|
123 | /** Returns Name of the Type for this OptionTrait.
|
---|
124 | * \return OptionTrait::InternalType->name()
|
---|
125 | */
|
---|
126 | const std::string OptionTrait::getTypeName() const
|
---|
127 | {
|
---|
128 | return InternalType->name();
|
---|
129 | }
|
---|
130 |
|
---|
131 | /** States whether DefaultValue is present or not.
|
---|
132 | * \return true - DefaultValue unequal to empty string present.
|
---|
133 | */
|
---|
134 | bool OptionTrait::hasDefaultValue() const
|
---|
135 | {
|
---|
136 | return (!DefaultValue.empty());
|
---|
137 | }
|
---|
138 |
|
---|
139 | /** States whether ShortForm is present or not.
|
---|
140 | * \return true - ShortForm unequal to empty string present.
|
---|
141 | */
|
---|
142 | bool OptionTrait::hasShortForm() const
|
---|
143 | {
|
---|
144 | return (!ShortForm.empty());
|
---|
145 | }
|
---|
146 |
|
---|
147 | /** Returns token of the option.
|
---|
148 | * \return name/token of option
|
---|
149 | */
|
---|
150 | const std::string& OptionTrait::getName() const
|
---|
151 | {
|
---|
152 | return Token;
|
---|
153 | }
|
---|
154 |
|
---|
155 | /** Sets the short form to the given value.
|
---|
156 | * \param &_shortform new short form
|
---|
157 | */
|
---|
158 | void OptionTrait::setShortForm(const std::string _shortform)
|
---|
159 | {
|
---|
160 | ShortForm = _shortform;
|
---|
161 | }
|
---|
162 |
|
---|
163 | /** Output operator for OptionTrait.
|
---|
164 | *
|
---|
165 | * \param &out output stream to print to.
|
---|
166 | */
|
---|
167 | std::ostream& operator<<(std::ostream &out, const OptionTrait &t)
|
---|
168 | {
|
---|
169 | out << "OptionTrait(" << &t << "): Name(" << t.getName() << ")";
|
---|
170 | out << ", Type(" << t.getTypeName() << ")";
|
---|
171 | out << ", Default(" << t.getDefaultValue() << ")";
|
---|
172 | out << ", ShortForm(" << t.getShortForm() << ")";
|
---|
173 | out << "." << std::endl;
|
---|
174 | return out;
|
---|
175 | }
|
---|