The documentation of a parameter. More...
#include <Parametrizable.h>
Public Member Functions | |
ParameterDoc (const std::string &name, const std::string &doc, const std::string &defaultValue, const std::string &minValue, const std::string &maxValue, LexicalComparison comp) | |
Construct a parameter documentation with bounds. | |
ParameterDoc (const std::string &name, const std::string &doc, const std::string &defaultValue) | |
Construct a parameter documentation without bounds. | |
Public Attributes | |
LexicalComparison | comp |
pointer to comparison function | |
std::string | defaultValue |
default value | |
std::string | doc |
short documentation | |
std::string | maxValue |
if bounds are checked, maxmimu value | |
std::string | minValue |
if bounds are checked, minimum value | |
std::string | name |
name | |
Friends | |
std::ostream & | operator<< (std::ostream &o, const ParameterDoc &p) |
Dump the documentation of this parameter to a stream. |
The documentation of a parameter.
Definition at line 117 of file Parametrizable.h.
PointMatcherSupport::Parametrizable::ParameterDoc::ParameterDoc | ( | const std::string & | name, |
const std::string & | doc, | ||
const std::string & | defaultValue, | ||
const std::string & | minValue, | ||
const std::string & | maxValue, | ||
LexicalComparison | comp | ||
) |
Construct a parameter documentation with bounds.
Definition at line 112 of file Parametrizable.cpp.
PointMatcherSupport::Parametrizable::ParameterDoc::ParameterDoc | ( | const std::string & | name, |
const std::string & | doc, | ||
const std::string & | defaultValue | ||
) |
Construct a parameter documentation without bounds.
Definition at line 122 of file Parametrizable.cpp.
std::ostream& operator<< | ( | std::ostream & | o, |
const ParameterDoc & | p | ||
) | [friend] |
Dump the documentation of this parameter to a stream.
Definition at line 51 of file Parametrizable.cpp.
pointer to comparison function
Definition at line 124 of file Parametrizable.h.
default value
Definition at line 121 of file Parametrizable.h.
short documentation
Definition at line 120 of file Parametrizable.h.
if bounds are checked, maxmimu value
Definition at line 123 of file Parametrizable.h.
if bounds are checked, minimum value
Definition at line 122 of file Parametrizable.h.
name
Definition at line 119 of file Parametrizable.h.