iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ParameterHelpers.H
Go to the documentation of this file.
1 /*! @file
2  @author Laurent Itti
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 
36 #ifndef INCLUDE_NRT_CORE_MODEL_DETAILS_PARAMETERHELPERS_H
37 #define INCLUDE_NRT_CORE_MODEL_DETAILS_PARAMETERHELPERS_H
38 
40 
41 namespace nrt
42 {
43  //! Generic variadic template class template definition for Component Parameters
44  /*! \see Parameter<Param, Tail ...> for detailed documentation. */
45  template <class ... Params> class Parameter;
46 
47  //! Special case to terminate variadic template inheritance recursion
48  /*! \see Parameter<Param, Tail ...> for detailed documentation. */
49  template <> class Parameter<> { };
50 
51 } // namespace nrt
52 
53 
54 // Convenience macro to define a Parameter type. All the ... args are passed to ParameterDef
55 #define NRT_DECLARE_PARAMETER(ParamName, ParamType, ...) \
56  struct ParamName : public virtual nrt::ParameterRegistry, public nrt::ParameterCore<ParamType> \
57  { \
58  typedef ParamType type; \
59  ParamName() : nrt::ParameterCore<ParamType>(nrt::ParameterDef<ParamType>(#ParamName, __VA_ARGS__)) \
60  { nrt::ParameterRegistry::addParameter(this); } \
61  virtual ~ParamName() \
62  { nrt::ParameterRegistry::removeParameter(this); } \
63  };
64 
65 // Convenience macro to define a Parameter type with callback. All the ... args are passed to ParameterDef
66 #define NRT_DECLARE_PARAMETER_WITH_CALLBACK(ParamName, ParamType, ...) \
67  struct ParamName : public virtual nrt::ParameterRegistry, public nrt::ParameterCore<ParamType> \
68  { \
69  typedef ParamType type; \
70  virtual void onParamChange(ParamName const & param, ParamType const & newval) = 0; \
71  ParamName() : nrt::ParameterCore<ParamType>(nrt::ParameterDef<ParamType>(#ParamName, __VA_ARGS__)) \
72  { setCallback([this](ParamType const & newval) { this->onParamChange(*this, newval); }); \
73  nrt::ParameterRegistry::addParameter(this); } \
74  virtual ~ParamName() \
75  { nrt::ParameterRegistry::removeParameter(this); } \
76  };
77 
78 #endif // INCLUDE_NRT_CORE_MODEL_DETAILS_PARAMETERHELPERS_H
79