Configuration - 1.2.3

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 ParameterSettable::ParameterSettable()
54 {
55 }
56 
57 ParameterSettable::~ParameterSettable()
58 {
59  foreach( RuntimeParameterObserver* obs, observers ) {
60  obs->onObjectDestruction( this );
61  }
62 }
63 
64 void ParameterSettable::addObserver( RuntimeParameterObserver* obs ) {
65  if ( !observers.contains( obs ) ) {
66  observers.append( obs );
67  }
68 }
69 
70 void ParameterSettable::removeObserver( RuntimeParameterObserver* obs ) {
71  observers.removeAll( obs );
72 }
73 
74 void ParameterSettable::notifyChangesToParam( QString paramName ) {
75  foreach( RuntimeParameterObserver* obs, observers ) {
76  obs->onParameterChanges( this, paramName );
77  }
78 }
79 
80 QString ParameterSettable::fullParameterDescriptionPath( QString type, QString param ) {
81  QString ret = type + "/";
82  QStringList groups = param.split( "/", QString::SkipEmptyParts );
83  for( int i=0; i<groups.size()-1; i++ ) {
84  ret += "Subgroups/"+groups[i]+"/";
85  }
86  ret += "Parameters/"+groups.last();
87  return ret;
88 }
89 
90 QString ParameterSettable::fullSubgroupDescriptionPath( QString type, QString sub ) {
91  QString ret = type + "/";
92  QStringList groups = sub.split( "/", QString::SkipEmptyParts );
93  foreach( QString agroup, groups ) {
94  ret += "Subgroups/"+agroup+"/";
95  }
96  return ret;
97 }
98 
99 void ParameterSettable::createParamDescription( QString paramPath, QString traitName, QString traitValue ) {
100  Factory::getTypeDescriptions().createParameter( paramPath, traitName, traitValue );
101 }
102 
103 ParameterSettable::Descriptor ParameterSettable::addTypeDescription( QString type, QString shortHelp, QString longHelp ) {
104  return Descriptor( type, shortHelp, longHelp );
105 }
106 
107 ParameterSettable::Descriptor::Descriptor( QString type, QString shortHelp, QString longHelp ) {
108  this->type = type;
109  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
110  typeDescr.createGroup( type );
111  typeDescr.createParameter( type, "shortHelp", shortHelp );
112  if ( longHelp != "" ) {
113  typeDescr.createParameter( type, "longHelp", longHelp );
114  }
115 }
116 
117 ParameterSettable::StringDescriptor ParameterSettable::Descriptor::describeString( QString parameter ) {
118  return StringDescriptor( type + "/Parameters/" + parameter );
119 }
120 
121 ParameterSettable::IntDescriptor ParameterSettable::Descriptor::describeInt( QString parameter ) {
122  return IntDescriptor( type + "/Parameters/" + parameter );
123 }
124 
125 ParameterSettable::RealDescriptor ParameterSettable::Descriptor::describeReal( QString parameter ) {
126  return RealDescriptor( type + "/Parameters/" + parameter );
127 }
128 
129 ParameterSettable::BoolDescriptor ParameterSettable::Descriptor::describeBool( QString parameter ) {
130  return BoolDescriptor( type + "/Parameters/" + parameter );
131 }
132 
133 ParameterSettable::EnumDescriptor ParameterSettable::Descriptor::describeEnum( QString parameter ) {
134  return EnumDescriptor( type + "/Parameters/" + parameter );
135 }
136 
137 ParameterSettable::ObjectDescriptor ParameterSettable::Descriptor::describeObject( QString parameter ) {
138  return ObjectDescriptor( type + "/Parameters/" + parameter );
139 }
140 
141 ParameterSettable::SubgroupDescriptor ParameterSettable::Descriptor::describeSubgroup( QString subgroup ) {
142  return SubgroupDescriptor( type + "/Subgroups/" + subgroup );
143 }
144 
145 ParameterSettable::StringDescriptor::StringDescriptor( QString paramPath ) {
146  this->paramPath = paramPath;
147  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
148  typeDescr.createGroup( paramPath );
149  typeDescr.createParameter( paramPath, "type", "string" );
150 }
151 
152 ParameterSettable::StringDescriptor& ParameterSettable::StringDescriptor::def( QString defaultValue ) {
153  Factory::getTypeDescriptions().createParameter( paramPath, "default", defaultValue );
154  return (*this);
155 }
156 
157 ParameterSettable::StringDescriptor& ParameterSettable::StringDescriptor::props( Properties properties ) {
158  setProperties( Factory::getTypeDescriptions(), paramPath, properties );
159  return (*this);
160 }
161 
162 ParameterSettable::StringDescriptor& ParameterSettable::StringDescriptor::help( QString shortHelp, QString longHelp ) {
163  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
164  typeDescr.createParameter( paramPath, "shortHelp", shortHelp );
165  if ( longHelp != "" ) {
166  typeDescr.createParameter( paramPath, "longHelp", longHelp );
167  }
168  return (*this);
169 }
170 
171 ParameterSettable::IntDescriptor::IntDescriptor( QString paramPath ) {
172  this->paramPath = paramPath;
173  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
174  typeDescr.createGroup( paramPath );
175  typeDescr.createParameter( paramPath, "type", "int" );
176 }
177 
178 ParameterSettable::IntDescriptor& ParameterSettable::IntDescriptor::def( int defaultValue ) {
179  Factory::getTypeDescriptions().createParameter( paramPath, "default", QString::number(defaultValue) );
180  return (*this);
181 }
182 
183 ParameterSettable::IntDescriptor& ParameterSettable::IntDescriptor::props( Properties properties ) {
184  setProperties( Factory::getTypeDescriptions(), paramPath, properties );
185  return (*this);
186 }
187 
188 ParameterSettable::IntDescriptor& ParameterSettable::IntDescriptor::limits( int lower_bound, int upper_bound ) {
189  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
190  if ( lower_bound != MinInteger ) {
191  typeDescr.createParameter( paramPath, "lowerBound", QString::number(lower_bound) );
192  }
193  if ( upper_bound != MaxInteger ) {
194  typeDescr.createParameter( paramPath, "upperBound", QString::number(upper_bound) );
195  }
196  return (*this);
197 }
198 
199 ParameterSettable::IntDescriptor& ParameterSettable::IntDescriptor::help( QString shortHelp, QString longHelp ) {
200  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
201  typeDescr.createParameter( paramPath, "shortHelp", shortHelp );
202  if ( longHelp != "" ) {
203  typeDescr.createParameter( paramPath, "longHelp", longHelp );
204  }
205  return (*this);
206 }
207 
208 ParameterSettable::RealDescriptor::RealDescriptor( QString paramPath ) {
209  this->paramPath = paramPath;
210  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
211  typeDescr.createGroup( paramPath );
212  typeDescr.createParameter( paramPath, "type", "real" );
213 }
214 
215 ParameterSettable::RealDescriptor& ParameterSettable::RealDescriptor::def( double defaultValue ) {
216  Factory::getTypeDescriptions().createParameter( paramPath, "default", QString::number(defaultValue) );
217  return (*this);
218 }
219 
220 ParameterSettable::RealDescriptor& ParameterSettable::RealDescriptor::props( Properties properties ) {
221  setProperties( Factory::getTypeDescriptions(), paramPath, properties );
222  return (*this);
223 }
224 
225 ParameterSettable::RealDescriptor& ParameterSettable::RealDescriptor::limits( double lower_bound, double upper_bound ) {
226  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
227  if ( lower_bound != -Infinity ) {
228  typeDescr.createParameter( paramPath, "lowerBound", QString::number(lower_bound) );
229  }
230  if ( upper_bound != +Infinity ) {
231  typeDescr.createParameter( paramPath, "upperBound", QString::number(upper_bound) );
232  }
233  return (*this);
234 }
235 
236 ParameterSettable::RealDescriptor& ParameterSettable::RealDescriptor::help( QString shortHelp, QString longHelp ) {
237  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
238  typeDescr.createParameter( paramPath, "shortHelp", shortHelp );
239  if ( longHelp != "" ) {
240  typeDescr.createParameter( paramPath, "longHelp", longHelp );
241  }
242  return (*this);
243 }
244 
245 ParameterSettable::BoolDescriptor::BoolDescriptor( QString paramPath ) {
246  this->paramPath = paramPath;
247  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
248  typeDescr.createGroup( paramPath );
249  typeDescr.createParameter( paramPath, "type", "bool" );
250 }
251 
252 ParameterSettable::BoolDescriptor& ParameterSettable::BoolDescriptor::def( bool defaultValue ) {
253  Factory::getTypeDescriptions().createParameter( paramPath, "default", (defaultValue ? "true" : "false") );
254  return (*this);
255 }
256 
257 ParameterSettable::BoolDescriptor& ParameterSettable::BoolDescriptor::props( Properties properties ) {
258  setProperties( Factory::getTypeDescriptions(), paramPath, properties );
259  return (*this);
260 }
261 
262 ParameterSettable::BoolDescriptor& ParameterSettable::BoolDescriptor::help( QString shortHelp, QString longHelp ) {
263  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
264  typeDescr.createParameter( paramPath, "shortHelp", shortHelp );
265  if ( longHelp != "" ) {
266  typeDescr.createParameter( paramPath, "longHelp", longHelp );
267  }
268  return (*this);
269 }
270 
271 ParameterSettable::EnumDescriptor::EnumDescriptor( QString paramPath ) {
272  this->paramPath = paramPath;
273  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
274  typeDescr.createGroup( paramPath );
275  typeDescr.createParameter( paramPath, "type", "enum" );
276 }
277 
278 ParameterSettable::EnumDescriptor& ParameterSettable::EnumDescriptor::def( QString defaultValue ) {
279  Factory::getTypeDescriptions().createParameter( paramPath, "default", defaultValue );
280  return (*this);
281 }
282 
283 ParameterSettable::EnumDescriptor& ParameterSettable::EnumDescriptor::props( Properties properties ) {
284  setProperties( Factory::getTypeDescriptions(), paramPath, properties );
285  return (*this);
286 }
287 
288 ParameterSettable::EnumDescriptor& ParameterSettable::EnumDescriptor::values( QStringList allValues ) {
289  Factory::getTypeDescriptions().createParameter( paramPath, "values", allValues.join(" ") );
290  return (*this);
291 }
292 
293 ParameterSettable::EnumDescriptor& ParameterSettable::EnumDescriptor::help( QString shortHelp, QString longHelp ) {
294  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
295  typeDescr.createParameter( paramPath, "shortHelp", shortHelp );
296  if ( longHelp != "" ) {
297  typeDescr.createParameter( paramPath, "longHelp", longHelp );
298  }
299  return (*this);
300 }
301 
302 ParameterSettable::ObjectDescriptor::ObjectDescriptor( QString paramPath ) {
303  this->paramPath = paramPath;
304  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
305  typeDescr.createGroup( paramPath );
306  typeDescr.createParameter( paramPath, "type", "object" );
307 }
308 
309 ParameterSettable::ObjectDescriptor& ParameterSettable::ObjectDescriptor::props( Properties properties ) {
310  setProperties( Factory::getTypeDescriptions(), paramPath, properties );
311  return (*this);
312 }
313 
314 ParameterSettable::ObjectDescriptor& ParameterSettable::ObjectDescriptor::type( QString className ) {
315  Factory::getTypeDescriptions().createParameter( paramPath, "class", className );
316  return (*this);
317 }
318 
319 ParameterSettable::ObjectDescriptor& ParameterSettable::ObjectDescriptor::help( QString shortHelp, QString longHelp ) {
320  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
321  typeDescr.createParameter( paramPath, "shortHelp", shortHelp );
322  if ( longHelp != "" ) {
323  typeDescr.createParameter( paramPath, "longHelp", longHelp );
324  }
325  return (*this);
326 }
327 
328 ParameterSettable::SubgroupDescriptor::SubgroupDescriptor( QString subgroupPath ) {
329  this->subgroupPath = subgroupPath;
330  Factory::getTypeDescriptions().createGroup( subgroupPath );
331 }
332 
333 ParameterSettable::SubgroupDescriptor& ParameterSettable::SubgroupDescriptor::props( Properties properties ) {
334  setProperties( Factory::getTypeDescriptions(), subgroupPath, properties );
335  return (*this);
336 }
337 
338 ParameterSettable::SubgroupDescriptor& ParameterSettable::SubgroupDescriptor::type( QString className ) {
339  Factory::getTypeDescriptions().createParameter( subgroupPath, "type", "object" );
340  Factory::getTypeDescriptions().createParameter( subgroupPath, "class", className );
341  return (*this);
342 }
343 
344 ParameterSettable::SubgroupDescriptor& ParameterSettable::SubgroupDescriptor::help( QString shortHelp, QString longHelp ) {
345  ConfigurationParameters& typeDescr = Factory::getTypeDescriptions();
346  typeDescr.createParameter( subgroupPath, "shortHelp", shortHelp );
347  if ( longHelp != "" ) {
348  typeDescr.createParameter( subgroupPath, "longHelp", longHelp );
349  }
350  return (*this);
351 }
352 
353 ParameterSettable::StringDescriptor ParameterSettable::SubgroupDescriptor::describeString( QString parameter ) {
354  return StringDescriptor( subgroupPath + "/Parameters/" + parameter );
355 }
356 
357 ParameterSettable::IntDescriptor ParameterSettable::SubgroupDescriptor::describeInt( QString parameter ) {
358  return IntDescriptor( subgroupPath + "/Parameters/" + parameter );
359 }
360 
361 ParameterSettable::RealDescriptor ParameterSettable::SubgroupDescriptor::describeReal( QString parameter ) {
362  return RealDescriptor( subgroupPath + "/Parameters/" + parameter );
363 }
364 
365 ParameterSettable::BoolDescriptor ParameterSettable::SubgroupDescriptor::describeBool( QString parameter ) {
366  return BoolDescriptor( subgroupPath + "/Parameters/" + parameter );
367 }
368 
369 ParameterSettable::EnumDescriptor ParameterSettable::SubgroupDescriptor::describeEnum( QString parameter ) {
370  return EnumDescriptor( subgroupPath + "/Parameters/" + parameter );
371 }
372 
373 ParameterSettable::ObjectDescriptor ParameterSettable::SubgroupDescriptor::describeObject( QString parameter ) {
374  return ObjectDescriptor( subgroupPath + "/Parameters/" + parameter );
375 }
376 
377 ParameterSettable::SubgroupDescriptor ParameterSettable::SubgroupDescriptor::describeSubgroup( QString subgroup ) {
378  return SubgroupDescriptor( subgroupPath + "/Subgroups/" + subgroup );
379 }
380 
381 } // end namespace farsa
382