The superclass of classes that are constructed using generic parameters. This class provides the parameter storage and fetching mechanism. More...
#include <Parametrizable.h>
Classes | |
| struct | InvalidParameter |
| An exception thrown when one tries to fetch the value of an unexisting parameter. More... | |
| struct | ParameterDoc |
| The documentation of a parameter. More... | |
Public Types | |
| typedef bool(* | LexicalComparison) (std::string a, std::string b) |
| A function that returns whether a is smaller than b. More... | |
| typedef std::string | Parameter |
| alias More... | |
| typedef std::map< std::string, Parameter > | Parameters |
| Parameters stored as a map of string->string. More... | |
| typedef std::vector< ParameterDoc > | ParametersDoc |
| The documentation of all parameters. More... | |
| typedef std::set< std::string > | ParametersUsed |
| Parameters whose value has been read. More... | |
Public Member Functions | |
| template<typename S > | |
| S | get (const std::string ¶mName) |
| Return the value of paramName, lexically-casted to S. More... | |
| std::string | getParamValueString (const std::string ¶mName) |
| Get the value of a parameter, as a string. More... | |
| template<typename T > | |
| std::vector< T > | getVector (const std::string ¶mName) |
| Return the value of paramName, lexically-casted std::vector<S> More... | |
| Parametrizable () | |
| Construct a documentation of parameters from a description in the source. More... | |
| Parametrizable (const std::string &className, const ParametersDoc paramsDoc, const Parameters ¶ms) | |
| Construct with documented parameters. More... | |
| virtual | ~Parametrizable () |
| Virtual destructor, do nothing. More... | |
Static Public Member Functions | |
| template<typename S > | |
| static bool | Comp (std::string a, std::string b) |
| Return whether a < b, lexically casted to S. More... | |
Public Attributes | |
| const std::string | className |
| name of the class More... | |
| Parameters | parameters |
| parameters with their values encoded in string More... | |
| const ParametersDoc | parametersDoc |
| documentation of parameters More... | |
| ParametersUsed | parametersUsed |
| parameters whose value has actually been read More... | |
Friends | |
| std::ostream & | operator<< (std::ostream &o, const Parametrizable &p) |
| Dump the documentation of this object to a stream. More... | |
Detailed Description
The superclass of classes that are constructed using generic parameters. This class provides the parameter storage and fetching mechanism.
Definition at line 141 of file Parametrizable.h.
Member Typedef Documentation
◆ LexicalComparison
| typedef bool(* PointMatcherSupport::Parametrizable::LexicalComparison) (std::string a, std::string b) |
A function that returns whether a is smaller than b.
Definition at line 150 of file Parametrizable.h.
◆ Parameter
| typedef std::string PointMatcherSupport::Parametrizable::Parameter |
alias
Definition at line 198 of file Parametrizable.h.
◆ Parameters
| typedef std::map<std::string, Parameter> PointMatcherSupport::Parametrizable::Parameters |
Parameters stored as a map of string->string.
Definition at line 199 of file Parametrizable.h.
◆ ParametersDoc
| typedef std::vector<ParameterDoc> PointMatcherSupport::Parametrizable::ParametersDoc |
The documentation of all parameters.
Definition at line 187 of file Parametrizable.h.
◆ ParametersUsed
| typedef std::set<std::string> PointMatcherSupport::Parametrizable::ParametersUsed |
Parameters whose value has been read.
Definition at line 200 of file Parametrizable.h.
Constructor & Destructor Documentation
◆ Parametrizable() [1/2]
| PointMatcherSupport::Parametrizable::Parametrizable | ( | ) |
Construct a documentation of parameters from a description in the source.
Construct an unknown class without parameters
Definition at line 165 of file Parametrizable.cpp.
◆ Parametrizable() [2/2]
| PointMatcherSupport::Parametrizable::Parametrizable | ( | const std::string & | className, |
| const ParametersDoc | paramsDoc, | ||
| const Parameters & | params | ||
| ) |
Construct with documented parameters.
Definition at line 170 of file Parametrizable.cpp.
◆ ~Parametrizable()
|
virtual |
Virtual destructor, do nothing.
Definition at line 195 of file Parametrizable.cpp.
Member Function Documentation
◆ Comp()
|
inlinestatic |
Return whether a < b, lexically casted to S.
Definition at line 154 of file Parametrizable.h.
◆ get()
|
inline |
Return the value of paramName, lexically-casted to S.
Definition at line 215 of file Parametrizable.h.
◆ getParamValueString()
| std::string PointMatcherSupport::Parametrizable::getParamValueString | ( | const std::string & | paramName | ) |
Get the value of a parameter, as a string.
Definition at line 199 of file Parametrizable.cpp.
◆ getVector()
|
inline |
Return the value of paramName, lexically-casted std::vector<S>
Definition at line 219 of file Parametrizable.h.
Friends And Related Function Documentation
◆ operator<<
|
friend |
Dump the documentation of this object to a stream.
Definition at line 62 of file Parametrizable.cpp.
Member Data Documentation
◆ className
| const std::string PointMatcherSupport::Parametrizable::className |
name of the class
Definition at line 202 of file Parametrizable.h.
◆ parameters
| Parameters PointMatcherSupport::Parametrizable::parameters |
parameters with their values encoded in string
Definition at line 204 of file Parametrizable.h.
◆ parametersDoc
| const ParametersDoc PointMatcherSupport::Parametrizable::parametersDoc |
documentation of parameters
Definition at line 203 of file Parametrizable.h.
◆ parametersUsed
| ParametersUsed PointMatcherSupport::Parametrizable::parametersUsed |
parameters whose value has actually been read
Definition at line 205 of file Parametrizable.h.
The documentation for this struct was generated from the following files: