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)
	Construct a parameter documentation without bounds. More...

	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. More...

Public Attributes
LexicalComparison	comp
	pointer to comparison function More...

std::string	defaultValue
	default value More...

std::string	doc
	short documentation More...

std::string	maxValue
	if bounds are checked, maxmimu value More...

std::string	minValue
	if bounds are checked, minimum value More...

std::string	name
	name More...

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

Detailed Description

The documentation of a parameter.

Definition at line 117 of file Parametrizable.h.

Constructor & Destructor Documentation

◆ ParameterDoc() [1/2]

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.

◆ ParameterDoc() [2/2]

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.

Friends And Related Function Documentation

◆ operator<<

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.

Member Data Documentation

◆ comp

LexicalComparison PointMatcherSupport::Parametrizable::ParameterDoc::comp

pointer to comparison function

Definition at line 124 of file Parametrizable.h.

◆ defaultValue

std::string PointMatcherSupport::Parametrizable::ParameterDoc::defaultValue

default value

Definition at line 121 of file Parametrizable.h.

◆ doc

std::string PointMatcherSupport::Parametrizable::ParameterDoc::doc

short documentation

Definition at line 120 of file Parametrizable.h.

◆ maxValue

std::string PointMatcherSupport::Parametrizable::ParameterDoc::maxValue

if bounds are checked, maxmimu value

Definition at line 123 of file Parametrizable.h.

◆ minValue

std::string PointMatcherSupport::Parametrizable::ParameterDoc::minValue

if bounds are checked, minimum value

Definition at line 122 of file Parametrizable.h.

◆ name

std::string PointMatcherSupport::Parametrizable::ParameterDoc::name

name

Definition at line 119 of file Parametrizable.h.

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

Public Member Functions

Public Attributes

Friends