Configuration - 1.1.0

Utilities Configuration GA
NNFW WorldSim Total 99% Experiments
parametersettable.cpp
1 /***************************************************************************
2  * Copyright (C) 2008-2011 by Tomassino Ferrauto *
3  * t_ferrauto@yahoo.it *
4  * *
5  * This program is free software; you can redistribute it and/or modify *
6  * it under the terms of the GNU General Public License as published by *
7  * the Free Software Foundation; either version 2 of the License, or *
8  * (at your option) any later version. *
9  * *
10  * This program is distributed in the hope that it will be useful, *
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13  * GNU General Public License for more details. *
14  * *
15  * You should have received a copy of the GNU General Public License *
16  * along with this program; if not, write to the *
17  * Free Software Foundation, Inc., *
18  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19  ***************************************************************************/
20 
21 #include "parametersettable.h"
22 #include "factory.h"
23 #include "configurationparameters.h"
24 #include "configurationhelper.h"
25 
26 // helper function for setting the properties of a parameter or a type
27 void setProperties( farsa::ConfigurationParameters& typeDescr, QString group, farsa::ParameterSettable::Properties props ) {
28  if ( props.testFlag( farsa::ParameterSettable::IsList ) ) {
29  typeDescr.createParameter( group, "isList", "true" );
30  } else {
31  typeDescr.createParameter( group, "isList", "false" );
32  }
33  if ( props.testFlag( farsa::ParameterSettable::IsMandatory ) ) {
34  typeDescr.createParameter( group, "isMandatory", "true" );
35  } else {
36  typeDescr.createParameter( group, "isMandatory", "false" );
37  }
38  if ( props.testFlag( farsa::ParameterSettable::AllowMultiple ) ) {
39  typeDescr.createParameter( group, "allowMultiple", "true" );
40  } else {
41  typeDescr.createParameter( group, "allowMultiple", "false" );
42  }
43 };
44 
45 namespace farsa {
46 
47 const double ParameterSettable::Infinity = std::numeric_limits<double>::infinity();
48 const int ParameterSettable::MaxInteger = std::numeric_limits<int>::max();
49 const int ParameterSettable::MinInteger = std::numeric_limits<int>::min();
50 
51 QMap<QString, RuntimeParameterSetter*> ParameterSettable::runtimeParameters;
52 
53 void ParameterSettable::addObserver( RuntimeParameterObserver* obs ) {
54  if ( !observers.contains( obs ) ) {
55  observers.append( obs );
56  }
57 }
58 
59 void ParameterSettable::removeObserver( RuntimeParameterObserver* obs ) {
60  observers.removeAll( obs );
61 }
62 
63 QString ParameterSettable::fullParameterDescriptionPath( QString type, QString param ) {
64  QString ret = type + "/";
65  QStringList groups = param.split( "/", QString::SkipEmptyParts );
66  for( int i=0; i<groups.size()-1; i++ ) {
67  ret += "Subgroups/"+groups[i]+"/";
68  }
69  ret += "Parameters/"+groups.last();
70  return ret;
71 }
72 
73 QString ParameterSettable::fullSubgroupDescriptionPath( QString type, QString sub ) {
74  QString ret = type + "/";
75  QStringList groups = sub.split( "/", QString::SkipEmptyParts );
76  foreach( QString agroup, groups ) {
77  ret += "Subgroups/"+agroup+"/";
78  }
79  return ret;
80 }
81 
82 void ParameterSettable::createParamDescription( QString paramPath, QString traitName, QString traitValue ) {
83  Factory::getTypeDescriptions().createParameter( paramPath, traitName, traitValue );
84 }
85 
86 ParameterSettable::Descriptor ParameterSettable::addTypeDescription( QString type, QString shortHelp, QString longHelp ) {
87  return Descriptor( type, shortHelp, longHelp );
88 }
89 
90 ParameterSettable::Descriptor::Descriptor( QString type, QString shortHelp, QString longHelp ) {
91  this->type = type;
92  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
93  typeDescr.createGroup( type );
94  typeDescr.createParameter( type, "shortHelp", shortHelp );
95  if ( longHelp != "" ) {
96  typeDescr.createParameter( type, "longHelp", longHelp );
97  }
98 }
99 
100 ParameterSettable::StringDescriptor ParameterSettable::Descriptor::describeString( QString parameter ) {
101  return StringDescriptor( type + "/Parameters/" + parameter );
102 }
103 
104 ParameterSettable::IntDescriptor ParameterSettable::Descriptor::describeInt( QString parameter ) {
105  return IntDescriptor( type + "/Parameters/" + parameter );
106 }
107 
108 ParameterSettable::RealDescriptor ParameterSettable::Descriptor::describeReal( QString parameter ) {
109  return RealDescriptor( type + "/Parameters/" + parameter );
110 }
111 
112 ParameterSettable::BoolDescriptor ParameterSettable::Descriptor::describeBool( QString parameter ) {
113  return BoolDescriptor( type + "/Parameters/" + parameter );
114 }
115 
116 ParameterSettable::EnumDescriptor ParameterSettable::Descriptor::describeEnum( QString parameter ) {
117  return EnumDescriptor( type + "/Parameters/" + parameter );
118 }
119 
120 ParameterSettable::ObjectDescriptor ParameterSettable::Descriptor::describeObject( QString parameter ) {
121  return ObjectDescriptor( type + "/Parameters/" + parameter );
122 }
123 
124 ParameterSettable::SubgroupDescriptor ParameterSettable::Descriptor::describeSubgroup( QString subgroup ) {
125  return SubgroupDescriptor( type + "/Subgroups/" + subgroup );
126 }
127 
128 ParameterSettable::StringDescriptor::StringDescriptor( QString paramPath ) {
129  this->paramPath = paramPath;
130  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
131  typeDescr.createGroup( paramPath );
132  typeDescr.createParameter( paramPath, "type", "string" );
133 }
134 
135 ParameterSettable::StringDescriptor& ParameterSettable::StringDescriptor::def( QString defaultValue ) {
136  Factory::getTypeDescriptions().createParameter( paramPath, "default", defaultValue );
137  return (*this);
138 }
139 
140 ParameterSettable::StringDescriptor& ParameterSettable::StringDescriptor::props( Properties properties ) {
141  setProperties( Factory::getTypeDescriptions(), paramPath, properties );
142  return (*this);
143 }
144 
145 ParameterSettable::StringDescriptor& ParameterSettable::StringDescriptor::help( QString shortHelp, QString longHelp ) {
146  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
147  typeDescr.createParameter( paramPath, "shortHelp", shortHelp );
148  if ( longHelp != "" ) {
149  typeDescr.createParameter( paramPath, "longHelp", longHelp );
150  }
151  return (*this);
152 }
153 
154 ParameterSettable::IntDescriptor::IntDescriptor( QString paramPath ) {
155  this->paramPath = paramPath;
156  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
157  typeDescr.createGroup( paramPath );
158  typeDescr.createParameter( paramPath, "type", "int" );
159 }
160 
161 ParameterSettable::IntDescriptor& ParameterSettable::IntDescriptor::def( int defaultValue ) {
162  Factory::getTypeDescriptions().createParameter( paramPath, "default", QString::number(defaultValue) );
163  return (*this);
164 }
165 
166 ParameterSettable::IntDescriptor& ParameterSettable::IntDescriptor::props( Properties properties ) {
167  setProperties( Factory::getTypeDescriptions(), paramPath, properties );
168  return (*this);
169 }
170 
171 ParameterSettable::IntDescriptor& ParameterSettable::IntDescriptor::limits( int lower_bound, int upper_bound ) {
172  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
173  if ( lower_bound != MinInteger ) {
174  typeDescr.createParameter( paramPath, "lowerBound", QString::number(lower_bound) );
175  }
176  if ( upper_bound != MaxInteger ) {
177  typeDescr.createParameter( paramPath, "upperBound", QString::number(upper_bound) );
178  }
179  return (*this);
180 }
181 
182 ParameterSettable::IntDescriptor& ParameterSettable::IntDescriptor::help( QString shortHelp, QString longHelp ) {
183  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
184  typeDescr.createParameter( paramPath, "shortHelp", shortHelp );
185  if ( longHelp != "" ) {
186  typeDescr.createParameter( paramPath, "longHelp", longHelp );
187  }
188  return (*this);
189 }
190 
191 ParameterSettable::RealDescriptor::RealDescriptor( QString paramPath ) {
192  this->paramPath = paramPath;
193  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
194  typeDescr.createGroup( paramPath );
195  typeDescr.createParameter( paramPath, "type", "real" );
196 }
197 
198 ParameterSettable::RealDescriptor& ParameterSettable::RealDescriptor::def( double defaultValue ) {
199  Factory::getTypeDescriptions().createParameter( paramPath, "default", QString::number(defaultValue) );
200  return (*this);
201 }
202 
203 ParameterSettable::RealDescriptor& ParameterSettable::RealDescriptor::props( Properties properties ) {
204  setProperties( Factory::getTypeDescriptions(), paramPath, properties );
205  return (*this);
206 }
207 
208 ParameterSettable::RealDescriptor& ParameterSettable::RealDescriptor::limits( double lower_bound, double upper_bound ) {
209  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
210  if ( lower_bound != -Infinity ) {
211  typeDescr.createParameter( paramPath, "lowerBound", QString::number(lower_bound) );
212  }
213  if ( upper_bound != +Infinity ) {
214  typeDescr.createParameter( paramPath, "upperBound", QString::number(upper_bound) );
215  }
216  return (*this);
217 }
218 
219 ParameterSettable::RealDescriptor& ParameterSettable::RealDescriptor::help( QString shortHelp, QString longHelp ) {
220  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
221  typeDescr.createParameter( paramPath, "shortHelp", shortHelp );
222  if ( longHelp != "" ) {
223  typeDescr.createParameter( paramPath, "longHelp", longHelp );
224  }
225  return (*this);
226 }
227 
228 ParameterSettable::BoolDescriptor::BoolDescriptor( QString paramPath ) {
229  this->paramPath = paramPath;
230  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
231  typeDescr.createGroup( paramPath );
232  typeDescr.createParameter( paramPath, "type", "bool" );
233 }
234 
235 ParameterSettable::BoolDescriptor& ParameterSettable::BoolDescriptor::def( bool defaultValue ) {
236  Factory::getTypeDescriptions().createParameter( paramPath, "default", (defaultValue ? "true" : "false") );
237  return (*this);
238 }
239 
240 ParameterSettable::BoolDescriptor& ParameterSettable::BoolDescriptor::props( Properties properties ) {
241  setProperties( Factory::getTypeDescriptions(), paramPath, properties );
242  return (*this);
243 }
244 
245 ParameterSettable::BoolDescriptor& ParameterSettable::BoolDescriptor::help( QString shortHelp, QString longHelp ) {
246  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
247  typeDescr.createParameter( paramPath, "shortHelp", shortHelp );
248  if ( longHelp != "" ) {
249  typeDescr.createParameter( paramPath, "longHelp", longHelp );
250  }
251  return (*this);
252 }
253 
254 ParameterSettable::EnumDescriptor::EnumDescriptor( QString paramPath ) {
255  this->paramPath = paramPath;
256  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
257  typeDescr.createGroup( paramPath );
258  typeDescr.createParameter( paramPath, "type", "enum" );
259 }
260 
261 ParameterSettable::EnumDescriptor& ParameterSettable::EnumDescriptor::def( QString defaultValue ) {
262  Factory::getTypeDescriptions().createParameter( paramPath, "default", defaultValue );
263  return (*this);
264 }
265 
266 ParameterSettable::EnumDescriptor& ParameterSettable::EnumDescriptor::props( Properties properties ) {
267  setProperties( Factory::getTypeDescriptions(), paramPath, properties );
268  return (*this);
269 }
270 
271 ParameterSettable::EnumDescriptor& ParameterSettable::EnumDescriptor::values( QStringList allValues ) {
272  Factory::getTypeDescriptions().createParameter( paramPath, "values", allValues.join(" ") );
273  return (*this);
274 }
275 
276 ParameterSettable::EnumDescriptor& ParameterSettable::EnumDescriptor::help( QString shortHelp, QString longHelp ) {
277  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
278  typeDescr.createParameter( paramPath, "shortHelp", shortHelp );
279  if ( longHelp != "" ) {
280  typeDescr.createParameter( paramPath, "longHelp", longHelp );
281  }
282  return (*this);
283 }
284 
285 ParameterSettable::ObjectDescriptor::ObjectDescriptor( QString paramPath ) {
286  this->paramPath = paramPath;
287  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
288  typeDescr.createGroup( paramPath );
289  typeDescr.createParameter( paramPath, "type", "object" );
290 }
291 
292 ParameterSettable::ObjectDescriptor& ParameterSettable::ObjectDescriptor::props( Properties properties ) {
293  setProperties( Factory::getTypeDescriptions(), paramPath, properties );
294  return (*this);
295 }
296 
297 ParameterSettable::ObjectDescriptor& ParameterSettable::ObjectDescriptor::type( QString className ) {
298  Factory::getTypeDescriptions().createParameter( paramPath, "class", className );
299  return (*this);
300 }
301 
302 ParameterSettable::ObjectDescriptor& ParameterSettable::ObjectDescriptor::help( QString shortHelp, QString longHelp ) {
303  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
304  typeDescr.createParameter( paramPath, "shortHelp", shortHelp );
305  if ( longHelp != "" ) {
306  typeDescr.createParameter( paramPath, "longHelp", longHelp );
307  }
308  return (*this);
309 }
310 
311 ParameterSettable::SubgroupDescriptor::SubgroupDescriptor( QString subgroupPath ) {
312  this->subgroupPath = subgroupPath;
313  Factory::getTypeDescriptions().createGroup( subgroupPath );
314 }
315 
316 ParameterSettable::SubgroupDescriptor& ParameterSettable::SubgroupDescriptor::props( Properties properties ) {
317  setProperties( Factory::getTypeDescriptions(), subgroupPath, properties );
318  return (*this);
319 }
320 
321 ParameterSettable::SubgroupDescriptor& ParameterSettable::SubgroupDescriptor::type( QString className ) {
322  Factory::getTypeDescriptions().createParameter( subgroupPath, "type", "object" );
323  Factory::getTypeDescriptions().createParameter( subgroupPath, "class", className );
324  return (*this);
325 }
326 
327 ParameterSettable::SubgroupDescriptor& ParameterSettable::SubgroupDescriptor::help( QString shortHelp, QString longHelp ) {
328  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
329  typeDescr.createParameter( subgroupPath, "shortHelp", shortHelp );
330  if ( longHelp != "" ) {
331  typeDescr.createParameter( subgroupPath, "longHelp", longHelp );
332  }
333  return (*this);
334 }
335 
336 ParameterSettable::StringDescriptor ParameterSettable::SubgroupDescriptor::describeString( QString parameter ) {
337  return StringDescriptor( subgroupPath + "/Parameters/" + parameter );
338 }
339 
340 ParameterSettable::IntDescriptor ParameterSettable::SubgroupDescriptor::describeInt( QString parameter ) {
341  return IntDescriptor( subgroupPath + "/Parameters/" + parameter );
342 }
343 
344 ParameterSettable::RealDescriptor ParameterSettable::SubgroupDescriptor::describeReal( QString parameter ) {
345  return RealDescriptor( subgroupPath + "/Parameters/" + parameter );
346 }
347 
348 ParameterSettable::BoolDescriptor ParameterSettable::SubgroupDescriptor::describeBool( QString parameter ) {
349  return BoolDescriptor( subgroupPath + "/Parameters/" + parameter );
350 }
351 
352 ParameterSettable::EnumDescriptor ParameterSettable::SubgroupDescriptor::describeEnum( QString parameter ) {
353  return EnumDescriptor( subgroupPath + "/Parameters/" + parameter );
354 }
355 
356 ParameterSettable::ObjectDescriptor ParameterSettable::SubgroupDescriptor::describeObject( QString parameter ) {
357  return ObjectDescriptor( subgroupPath + "/Parameters/" + parameter );
358 }
359 
360 ParameterSettable::SubgroupDescriptor ParameterSettable::SubgroupDescriptor::describeSubgroup( QString subgroup ) {
361  return SubgroupDescriptor( subgroupPath + "/Subgroups/" + subgroup );
362 }
363 
364 } // end namespace farsa
365