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:

[legend]

List of all members.

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::string	Parameter
	alias
typedef std::map< std::string, Parameter >	Parameters
	Parameters stored as a map of string->string.
typedef std::vector< ParameterDoc >	ParametersDoc
	The documentation of all parameters.
typedef std::set< std::string >	ParametersUsed
	Parameters whose value has been read.
Public Member Functions
template<typename S >
S	get (const std::string &paramName)
	Return the value of paramName, lexically-casted to S.
std::string	getParamValueString (const std::string &paramName)
	Get the value of a parameter, as a string.
	Parametrizable ()
	Construct a documentation of parameters from a description in the source.
	Parametrizable (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
	Construct with documented parameters.
virtual	~Parametrizable ()
	Virtual destructor, do nothing.
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
Parameters	parameters
	parameters with their values encoded in string
const ParametersDoc	parametersDoc
	documentation of parameters
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.

Definition at line 91 of file Parametrizable.h.

Member Typedef Documentation

typedef bool(* PointMatcherSupport::Parametrizable::LexicalComparison)(std::string a, std::string b)

A function that returns whether a is smaller than b.

Definition at line 100 of file Parametrizable.h.

typedef std::string PointMatcherSupport::Parametrizable::Parameter

alias

Definition at line 148 of file Parametrizable.h.

typedef std::map<std::string, Parameter> PointMatcherSupport::Parametrizable::Parameters

Parameters stored as a map of string->string.

Reimplemented in DataPointsFiltersImpl< T >::VoxelGridDataPointsFilter.

Definition at line 149 of file Parametrizable.h.

typedef std::vector<ParameterDoc> PointMatcherSupport::Parametrizable::ParametersDoc

The documentation of all parameters.

Reimplemented in DataPointsFiltersImpl< T >::VoxelGridDataPointsFilter.

Definition at line 137 of file Parametrizable.h.

typedef std::set<std::string> PointMatcherSupport::Parametrizable::ParametersUsed

Parameters whose value has been read.

Definition at line 150 of file Parametrizable.h.

Constructor & Destructor Documentation

PointMatcherSupport::Parametrizable::Parametrizable ( )

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

Construct an unknown class without parameters

Definition at line 164 of file Parametrizable.cpp.

PointMatcherSupport::Parametrizable::Parametrizable	(	const std::string &	className,
		const ParametersDoc	paramsDoc,
		const Parameters &	params
	)

Construct with documented parameters.

Definition at line 169 of file Parametrizable.cpp.

PointMatcherSupport::Parametrizable::~Parametrizable ( ) [virtual]

Virtual destructor, do nothing.

Definition at line 194 of file Parametrizable.cpp.

Member Function Documentation

template<typename S >

static bool PointMatcherSupport::Parametrizable::Comp	(	std::string	a,
		std::string	b
	)		`[inline, static]`

Return whether a < b, lexically casted to S.

Definition at line 104 of file Parametrizable.h.

template<typename S >

S PointMatcherSupport::Parametrizable::get ( const std::string & paramName ) [inline]

Return the value of paramName, lexically-casted to S.

Definition at line 165 of file Parametrizable.h.

std::string PointMatcherSupport::Parametrizable::getParamValueString ( const std::string & paramName )

Get the value of a parameter, as a string.

Definition at line 198 of file Parametrizable.cpp.

Friends And Related Function Documentation

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

Dump the documentation of this object to a stream.

Definition at line 61 of file Parametrizable.cpp.

Member Data Documentation

const std::string PointMatcherSupport::Parametrizable::className

name of the class

Definition at line 152 of file Parametrizable.h.

Parameters PointMatcherSupport::Parametrizable::parameters

parameters with their values encoded in string

Definition at line 154 of file Parametrizable.h.

const ParametersDoc PointMatcherSupport::Parametrizable::parametersDoc

documentation of parameters

Definition at line 153 of file Parametrizable.h.

ParametersUsed PointMatcherSupport::Parametrizable::parametersUsed

parameters whose value has actually been read

Definition at line 155 of file Parametrizable.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions