Class Parameter

Inheritance Relationships

Derived Types

Class Documentation

class Parameter

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.

Subclassed by ompl::ParameterExponentialDecay, ompl::ParameterSmoothStep

Public Functions

Parameter() = default
inline Parameter(double valueInit)
inline Parameter(double valueInit, double valueTarget)
inline void setValueInit(double valueInit)

Set initial value (default: 0.0)

inline void setValueTarget(double valueTarget)

Set target value (default: 1.0)

inline void setCounterInit(unsigned long long counterInit)

Set counter init value (default: 0)

inline void setCounterTarget(unsigned long long counterTarget)

Set counter target value (default: 100)

inline double getValueInit()

Get init value.

inline double getValueTarget()

Get target value.

inline unsigned long long getCounterInit()

Get counter init value.

inline unsigned long long getCounterTarget()

Get counter target value.

inline double operator()(void)

Call parameter and increase counter.

inline void reset()

Reset counter to init counter.

inline unsigned long long getCounter()

Get current counter.

inline void incrementCounter()

Increment counter.