source: src/Parameters/Parameter_impl.hpp@ b5b114

Last change on this file since b5b114 was 0d4168, checked in by Frederik Heber <heber@…>, 11 years ago

Allow setting of invalid values in Value class, Action::performCall() catches ParameterExceptions.

Value changes:

  • Values are now checked with get().
  • having the Actions fill their parameters on instantiation may lead to invalid values because actions that, e.g. add an atom and thereby make a so far invalid atomic id now valid, still have to get executed.
  • hence, we allow setting of invalid values. Validity is check/enforced on get(), i.e. when the Action is actually performed and not before. This is also the very moment where the parameters are first required to be valid.
  • Parameter::clone() and copy cstor must not use get() as invalid values are there still allowed.
  • TESTFIX: Value behavior changed.
  • TESTFIX: regression test add atom outside boundary is working again.
  • TESTFIX: regression tests load/store-session would be skipped as loading non-present file fails now. We use --help --actionname instead.

Action changes:

  • are turned into Action::failure.
  • ActionQueue calling an Action wrapped in try/catch-block for ActionFailure.
  • removed try/catch in doUI().
  • as exception (will) occur in ActionQueue's queue_thread, we need to catch it there. As the only thing we do is set the exit flag of the World. We can do this in ActionQueue as well.
  • Property mode set to 100644
File size: 6.3 KB
Line 
1/*
2 * Parameter_impl.hpp
3 *
4 * Created on: Apr 16, 2012
5 * Author: ankele
6 */
7
8#ifndef PARAMETER_IMPL_HPP_
9#define PARAMETER_IMPL_HPP_
10
11// include config.h
12#ifdef HAVE_CONFIG_H
13#include <config.h>
14#endif
15
16#include "Parameter.hpp"
17#include "ParameterExceptions.hpp"
18
19
20template<typename T>
21Parameter<T>::Parameter(const Parameter<T> &instance) :
22 ParameterInterface(instance.getName()),
23 value(instance.value.getValidator())
24{
25 value.set(instance.value.value);
26}
27
28/** Constructor for class Parameter.
29 *
30 */
31template<typename T>
32Parameter<T>::Parameter() :
33 ParameterInterface("__no_name__"),
34 value()
35{};
36
37/** Constructor for class Parameter.
38 *
39 */
40template<typename T>
41Parameter<T>::Parameter(const std::string &_name) :
42 ParameterInterface(_name),
43 value()
44{};
45
46/** Constructor for class Parameter.
47 *
48 * @param _name name of this parameter
49 * @param _value initial value to set
50 */
51template<typename T>
52Parameter<T>::Parameter(const std::string &_name, const T &_value) :
53 ParameterInterface(_name),
54 value()
55{
56 value.set(_value);
57};
58
59/** Constructor for class Parameter.
60 *
61 * @param _name name of this parameter
62 * @param _ValidRange valid range for this ContinuousValue
63 */
64template<typename T>
65Parameter<T>::Parameter(const std::string &_name, const Validator<T> &_Validator) :
66 ParameterInterface(_name),
67 value(_Validator)
68{};
69
70/** Constructor for class Parameter.
71 *
72 * @param _name name of this parameter
73 * @param _ValidRange valid range for this ContinuousValue
74 * @param _value initial value to set
75 */
76template<typename T>
77Parameter<T>::Parameter(const std::string &_name, const Validator<T> &_Validator, const T &_value) :
78 ParameterInterface(_name),
79 value(_Validator)
80{
81 value.set(_value);
82};
83
84/** Constructor for class Parameter.
85 *
86 * @param _name name of this parameter
87 * @param _ValidRange valid range for this ContinuousValue
88 */
89template<typename T>
90Parameter<T>::Parameter(const std::string &_name, const std::vector<T> &_ValidValues) :
91 ParameterInterface(_name),
92 value(_ValidValues)
93{};
94
95/** Constructor for class Parameter.
96 *
97 * @param _name name of this parameter
98 * @param _ValidRange valid range for this ContinuousValue
99 * @param _value initial value to set
100 */
101template<typename T>
102Parameter<T>::Parameter(const std::string &_name, const std::vector<T> &_ValidValues, const T &_value) :
103 ParameterInterface(_name),
104 value(_ValidValues)
105{
106 value.set(_value);
107};
108
109/** Constructor for class Parameter.
110 *
111 * @param _name name of this parameter
112 * @param _ValidRange valid range for this ContinuousValue
113 */
114template<typename T>
115Parameter<T>::Parameter(const std::string &_name, const range<T> &_ValidRange) :
116 ParameterInterface(_name),
117 value(_ValidRange)
118{};
119
120/** Constructor for class Parameter.
121 *
122 * @param _name name of this parameter
123 * @param _ValidRange valid range for this ContinuousValue
124 * @param _value initial value to set
125 */
126template<typename T>
127Parameter<T>::Parameter(const std::string &_name, const range<T> &_ValidRange, const T &_value) :
128 ParameterInterface(_name),
129 value(_ValidRange)
130{
131 value.set(_value);
132};
133
134/** Destructor for class Parameter.
135 *
136 */
137template<typename T>
138Parameter<T>::~Parameter()
139{};
140
141/** Catch call to value.isValidAsString() to add exception information.
142 *
143 * @param _value value to set to
144 */
145template<typename T>
146inline
147bool Parameter<T>::isValidAsString(const std::string &_value) const throw(ParameterValidatorException)
148{
149 try {
150 return value.isValidAsString(_value);
151 } catch(ParameterException &e) {
152 e << ParameterName(ParameterInterface::getName());
153 throw;
154 }
155}
156
157
158/** Catch call to value.getAsString() to add exception information.
159 *
160 * @return parameter value as string
161 */
162template<typename T>
163inline const std::string Parameter<T>::getAsString() const throw(ParameterValueException)
164{
165 try {
166 return value.getAsString();
167 } catch(ParameterException &e) {
168 e << ParameterName(ParameterInterface::getName());
169 throw;
170 }
171}
172
173/** Catch call to value.isValid() to add exception information.
174 *
175 * @return parameter value as string
176 */
177template<typename T>
178inline bool Parameter<T>::isValid(const T &_value) const throw(ParameterValidatorException)
179{
180 try {
181 return value.isValid(_value);
182 } catch(ParameterException &e) {
183 e << ParameterName(ParameterInterface::getName());
184 throw;
185 }
186}
187
188
189/** Catch call to value.get() to add exception information.
190 *
191 * @return parameter value as string
192 */
193template<typename T>
194inline const T & Parameter<T>::get() const throw(ParameterValueException)
195{
196 try {
197 return value.get();
198 } catch(ParameterException &e) {
199 e << ParameterName(ParameterInterface::getName());
200 throw;
201 }
202}
203
204/** Catch call to value.set() to add exception information.
205 *
206 * @param _value value to set to
207 */
208template<typename T>
209inline void Parameter<T>::set(const T & _value) throw(ParameterValueException)
210{
211 try {
212 value.set(_value);
213 } catch(ParameterException &e) {
214 e << ParameterName(ParameterInterface::getName());
215 throw;
216 }
217}
218
219/** Catch call to value.set() to add exception information.
220 *
221 * @param _value value to set to
222 */
223template<typename T>
224inline void Parameter<T>::setAsString(const std::string &_value) throw(ParameterValueException)
225{
226 try {
227 value.setAsString(_value);
228 } catch(ParameterException &e) {
229 e << ParameterName(ParameterInterface::getName());
230 throw;
231 }
232}
233
234/** Compares this continuous value against another \a _instance.
235 *
236 * @param _instance other value to compare to
237 * @return true - if contained ContinuousValue and name are the same, false - else
238 */
239template <class T>
240bool Parameter<T>::operator==(const Parameter<T> &_instance) const throw(ParameterException)
241{
242 bool status = true;
243 try {
244 status = status &&
245 (value == _instance.value);
246 status = status && (ParameterInterface::getName() == _instance.ParameterInterface::getName());
247 } catch(ParameterException &e) {
248 e << ParameterName(ParameterInterface::getName());
249 throw;
250 }
251 return status;
252}
253
254/** Creates a clone of this Parameter instance.
255 *
256 * @return cloned instance
257 */
258template<typename T>
259inline ParameterInterface* Parameter<T>::clone() const
260{
261 Parameter<T> *instance = new Parameter<T>(ParameterInterface::getName(), value.getValidator());
262 // do not use get, we do not check for validity here
263 if (value.ValueSet)
264 instance->set(value.value);
265 return instance;
266}
267
268
269#endif /* Parameter_IMPL_HPP_ */
Note: See TracBrowser for help on using the repository browser.