iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ParameterSummary.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_PARAMETERSUMMARY_H
37 #define INCLUDE_NRT_CORE_MODEL_PARAMETERSUMMARY_H
38 
40 #include <nrt/External/cereal/types/string.hpp>
41 
42 namespace nrt
43 {
44 // ######################################################################
45  //! State of a parameter, received with a ParameterSummary
46  /*! Parties interested in ParameterSummary would typically want to know why they are receiving a summary, which can be
47  upon creation, modification/update, or destruction of a Parameter.
48  \ingroup parameter */
49  enum class ParameterState { Create, Update, Destroy };
50 
51  // ######################################################################
52  //! ParameterSummary provides a summary about a parameter that can be used by a GUI and across Blackboards
53  /*! \ingroup parameter */
55  {
56  public:
57  //! Descriptor. This is the name of the parameter, qualified by a chain of component names
58  std::string descriptor;
59 
60  //! Plain name of the parameter
61  std::string name;
62 
63  //! Description of the parameter
64  std::string description;
65 
66  //! Parameter value type, as a string
67  std::string valuetype;
68 
69  //! Default value of the parameter, as a string
70  std::string defaultvalue;
71 
72  //! Current value of the parameter, as a string
73  std::string value;
74 
75  //! Description of the parameter's valid values specification, as a string
76  std::string validvalues;
77 
78  //! Parameter flags
80 
81  //! Category of the parameter, as a string
82  std::string category;
83 
84  //! Category description
85  std::string categorydescription;
86 
87  //! Serialization
88  template <class Archive> void serialize(Archive & ar)
89  {
92  }
93  };
94 }
95 
96 #endif // INCLUDE_NRT_CORE_MODEL_PARAMETERSUMMARY_H