Public Member Functions | Public Attributes | Friends
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

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.

Detailed Description

The documentation of a parameter.

Definition at line 110 of file Parametrizable.h.


Constructor & Destructor Documentation

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 111 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 121 of file Parametrizable.cpp.


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o,
const ParameterDoc p 
) [friend]

Dump the documentation of this parameter to a stream.

Definition at line 50 of file Parametrizable.cpp.


Member Data Documentation

pointer to comparison function

Definition at line 117 of file Parametrizable.h.

default value

Definition at line 114 of file Parametrizable.h.

short documentation

Definition at line 113 of file Parametrizable.h.

if bounds are checked, maxmimu value

Definition at line 116 of file Parametrizable.h.

if bounds are checked, minimum value

Definition at line 115 of file Parametrizable.h.

name

Definition at line 112 of file Parametrizable.h.


The documentation for this struct was generated from the following files:


libpointmatcher
Author(s):
autogenerated on Mon Sep 14 2015 02:59:07