Parameter represents a smooth interpolation between two parameter values, namely valueInit and valueTarget. The default class keeps a counter to track how often it was called. Starting at counterInit we then count towards counterTarget and smoothly interpolate parameter values inbetween. More...
#include <ompl/multilevel/datastructures/Parameter.h>

Public Member Functions | |
Parameter (double valueInit) | |
Parameter (double valueInit, double valueTarget) | |
void | setValueInit (double valueInit) |
Set initial value (default: 0.0) | |
void | setValueTarget (double valueTarget) |
Set target value (default: 1.0) | |
void | setCounterInit (unsigned long long counterInit) |
Set counter init value (default: 0) | |
void | setCounterTarget (unsigned long long counterTarget) |
Set counter target value (default: 100) | |
double | getValueInit () |
Get init value. | |
double | getValueTarget () |
Get target value. | |
unsigned long long | getCounterInit () |
Get counter init value. | |
unsigned long long | getCounterTarget () |
Get counter target value. | |
double | operator() (void) |
Call parameter and increase counter. | |
void | reset () |
Reset counter to init counter. | |
unsigned long long | getCounter () |
Get current counter. | |
void | incrementCounter () |
Increment counter. | |
Detailed Description
Parameter represents a smooth interpolation between two parameter values, namely valueInit and valueTarget. The default class keeps a counter to track how often it was called. Starting at counterInit we then count towards counterTarget and smoothly interpolate parameter values inbetween.
Definition at line 51 of file Parameter.h.
Constructor & Destructor Documentation
◆ Parameter() [1/2]
|
inline |
Definition at line 56 of file Parameter.h.
◆ Parameter() [2/2]
|
inline |
Definition at line 58 of file Parameter.h.
Member Function Documentation
◆ getCounter()
|
inline |
Get current counter.
Definition at line 123 of file Parameter.h.
◆ getCounterInit()
|
inline |
Get counter init value.
Definition at line 92 of file Parameter.h.
◆ getCounterTarget()
|
inline |
Get counter target value.
Definition at line 97 of file Parameter.h.
◆ getValueInit()
|
inline |
Get init value.
Definition at line 82 of file Parameter.h.
◆ getValueTarget()
|
inline |
Get target value.
Definition at line 87 of file Parameter.h.
◆ incrementCounter()
|
inline |
Increment counter.
Definition at line 128 of file Parameter.h.
◆ operator()()
|
inline |
Call parameter and increase counter.
Definition at line 103 of file Parameter.h.
◆ reset()
|
inline |
Reset counter to init counter.
Definition at line 117 of file Parameter.h.
◆ setCounterInit()
|
inline |
Set counter init value (default: 0)
Definition at line 71 of file Parameter.h.
◆ setCounterTarget()
|
inline |
Set counter target value (default: 100)
Definition at line 76 of file Parameter.h.
◆ setValueInit()
|
inline |
Set initial value (default: 0.0)
Definition at line 61 of file Parameter.h.
◆ setValueTarget()
|
inline |
Set target value (default: 1.0)
Definition at line 66 of file Parameter.h.
The documentation for this class was generated from the following file:
- ompl/multilevel/datastructures/Parameter.h