PointMatcherSupport::Parametrizable::ParameterDoc Struct Reference

The documentation of a parameter. More...

#include <Parametrizable.h>

List of all members.

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

std::string name
 name
std::string doc
 short documentation
std::string defaultValue
 default value
std::string minValue
 if bounds are checked, minimum value
std::string maxValue
 if bounds are checked, maxmimu value
LexicalComparison comp
 pointer to comparison function

Friends

std::ostream & operator<< (std::ostream &o, const ParameterDoc &p)
 Dump the documentation of this parameter to a stream.

Detailed Description

The documentation of a parameter.


The documentation for this struct was generated from the following files:
Generated on Fri May 3 12:51:03 2013 for libpointmatcher by  doxygen 1.6.3