All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator
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)
 GenericParam (const std::string &name, const msg::Interface &context)
 The constructor of a parameter takes the name of the parameter (name) and a context (context) for that parameter. The contex is used for console output.
const std::stringgetName (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.

Protected Attributes

std::string name_
 The name of the parameter.
const msg::Interfacemsg_
 Interface for publishing console messages.

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.


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