hpp-core: hpp::core::ParameterDescription Class Reference

hpp-core 9.0.2 Implement basic classes for canonical path planning for kinematic chains.

Loading...
Searching...
No Matches
Public Member Functions | List of all members
hpp::core::ParameterDescription Class Reference

`#include <hpp/core/parameter.hh>`

## Public Member Functions
| ParameterDescription (Parameter::Type type, std::string name, std::string doc="", Parameter defaultValue=Parameter())
| ParameterDescription ()
const std::string & | name () const
const Parameter::Type & | type () const
const std::string & | doc () const
const Parameter & | defaultValue () const

## Constructor & Destructor Documentation

## ◆ ParameterDescription() [1/2]

hpp::core::ParameterDescription::ParameterDescription | ( | Parameter::Type | type,
|  | std::string | name,
|  | std::string | doc = `""`,
|  | Parameter | defaultValue = `Parameter()`
| ) |  |
| inline

## ◆ ParameterDescription() [2/2]

hpp::core::ParameterDescription::ParameterDescription | ( |  | ) |
| inline

## Member Function Documentation

## ◆ defaultValue()

const Parameter & hpp::core::ParameterDescription::defaultValue | ( |  | ) | const

## ◆ doc()

const std::string & hpp::core::ParameterDescription::doc | ( |  | ) | const
| inline

## ◆ name()

const std::string & hpp::core::ParameterDescription::name | ( |  | ) | const
| inline

## ◆ type()

const Parameter::Type & hpp::core::ParameterDescription::type | ( |  | ) | const
| inline

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

- include/hpp/core/parameter.hh