All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
ompl::base::GenericParam Class Reference

Motion planning algorithms often employ parameters to guide their exploration process. (e.g., goal biasing). Motion planners (and some of their components) use this class to declare what the parameters are, in a generic way, so that they can be set externally. More...

#include <GenericParam.h>

Inheritance diagram for ompl::base::GenericParam:

List of all members.

Public Member Functions

 GenericParam (const std::string &name)
 The constructor of a parameter takes the name of the parameter (name)
const std::string & getName (void) const
 Get the name of the parameter.
void setName (const std::string &name)
 Set the name of the parameter.
virtual bool setValue (const std::string &value)=0
 Set the value of the parameter. The value is taken in as a string, but converted to the type of that parameter.
virtual std::string getValue (void) const =0
 Retrieve the value of the parameter, as a string.
template<typename T >
GenericParamoperator= (const T &value)
 Assignment operator by type. This is just for convenience, as it just calls setValue()

Protected Attributes

std::string name_
 The name of the parameter.

Detailed Description

Motion planning algorithms often employ parameters to guide their exploration process. (e.g., goal biasing). Motion planners (and some of their components) use this class to declare what the parameters are, in a generic way, so that they can be set externally.

Definition at line 64 of file GenericParam.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines