ompl::base::SpecificParam< T > Class Template Reference

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

#include <ompl/base/GenericParam.h>

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

Public Types

typedef std::function< void(T)> SetterFn
 The type for the 'setter' function for this parameter.
 
typedef std::function< T()> GetterFn
 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.
 
- 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 >
GenericParamoperator= (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 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...
 

Additional Inherited Members

- Protected Member Functions inherited from ompl::base::GenericParam
template<typename T >
const std::string & maybeWrapBool (const std::string &value) const
 Bool values such as "false" cannot be converted to bool using lexical_cast. We need to map those to "0" or "1".
 

Detailed Description

template<typename T>
class ompl::base::SpecificParam< T >

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

Definition at line 154 of file GenericParam.h.


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