PointMatcherSupport::Parametrizable Struct Reference

The superclass of classes that are constructed using generic parameters. This class provides the parameter storage and fetching mechanism. More...

#include <Parametrizable.h>

Inheritance diagram for PointMatcherSupport::Parametrizable:

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.
typedef std::vector< ParameterDoc >	ParametersDoc
	The documentation of all parameters.
typedef std::string	Parameter
	alias
typedef std::map< std::string, Parameter >	Parameters
	Parameters stored as a map of string->string.
typedef std::set< std::string >	ParametersUsed
	Parameters whose value has been read.

Public Member Functions
	Parametrizable ()
	Construct a documentation of parameters from a description in the source. More...
	Parametrizable (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
	Construct with documented parameters.
virtual	~Parametrizable ()
	Virtual destructor, do nothing.
std::string	getParamValueString (const std::string &paramName)
	Get the value of a parameter, as a string.
template<typename S >
S	get (const std::string &paramName)
	Return the value of paramName, lexically-casted to S.

Static Public Member Functions
template<typename S >
static bool	Comp (std::string a, std::string b)
	Return whether a < b, lexically casted to S.

Public Attributes
const std::string	className
	name of the class
const ParametersDoc	parametersDoc
	documentation of parameters
Parameters	parameters
	parameters with their values encoded in string
ParametersUsed	parametersUsed
	parameters whose value has actually been read

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

Detailed Description

The superclass of classes that are constructed using generic parameters. This class provides the parameter storage and fetching mechanism.

Constructor & Destructor Documentation

Parametrizable()

PointMatcherSupport::Parametrizable::Parametrizable

(

)

Construct a documentation of parameters from a description in the source.

Construct an unknown class without parameters

---

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

• Parametrizable.h
• Parametrizable.cpp