This is a helper class that instantiates parameters with different data types. More...

Inheritance diagram for ompl::base::SpecificParam< T >:

Public Types
using	SetterFn = std::function< void(T)>
	The type for the 'setter' function for this parameter.

using	GetterFn = std::function< T()>
	The type for the 'getter' function for this parameter.

Public Member Functions
	SpecificParam (const std::string &name, SetterFn setter, GetterFn getter=GetterFn())
	An explicit instantiation of a parameter name requires the setter function and optionally the getter function.

bool	setValue (const std::string &value) override
	Set the value of the parameter. The value is taken in as a string, but converted to the type of that parameter.

std::string	getValue () const override
	Retrieve the value of the parameter, as a string.

std::string	getValue () const
	Retrieve the value of the parameter, as a string.

std::string	getValue () const
	Retrieve the value of the parameter, as a string.

std::string	getValue () const
	Retrieve the value of the parameter, as a string.

std::string	getValue () const
	Retrieve the value of the parameter, as a string.

Public Member Functions inherited from ompl::base::GenericParam
	GenericParam (std::string name)
	The constructor of a parameter takes the name of the parameter (name)

const std::string &	getName () const
	Get the name of the parameter.

void	setName (const std::string &name)
	Set the name of the parameter.

template<typename T >
GenericParam &	operator= (const T &value)
	Assignment operator by type. This is just for convenience, as it just calls setValue()

void	setRangeSuggestion (const std::string &rangeSuggestion)
	Set a suggested range.

const std::string &	getRangeSuggestion () const
	Get the suggested range of values.

Protected Member Functions
T	lexical_cast (const std::string &value) const
	Helper function to convert strings into objects of type T. More...

bool	lexical_cast (const std::string &value) const

int	lexical_cast (const std::string &value) const

long	lexical_cast (const std::string &value) const

long long	lexical_cast (const std::string &value) const

unsigned int	lexical_cast (const std::string &value) const

unsigned long	lexical_cast (const std::string &value) const

unsigned long long	lexical_cast (const std::string &value) const

float	lexical_cast (const std::string &value) const

double	lexical_cast (const std::string &value) const

long double	lexical_cast (const std::string &value) const

char	lexical_cast (const std::string &value) const

std::string	lexical_cast (const std::string &value) const

Protected Attributes
SetterFn	setter_
	The setter function for this parameter.

GetterFn	getter_
	The getter function for this parameter.

Protected Attributes inherited from ompl::base::GenericParam
std::string	name_
	The name of the parameter.

std::string	rangeSuggestion_
	Suggested range for the parameter. More...

Detailed Description

This is a helper class that instantiates parameters with different data types.

Definition at line 200 of file GenericParam.h.

Member Function Documentation

template<typename T >

T ompl::base::SpecificParam< T >::lexical_cast ( const std::string & value ) const

protected

Helper function to convert strings into objects of type T.

Supported types are: bool, int, long, long long, unsigned int, unsigned long, unsigned long long, float, double, long double, char, std::string.

The documentation for this class was generated from the following file: