TPIK  1.0
Task Priority Inverse Kinematics
Loading...
Searching...
No Matches
tpik::TaskParameter Struct Reference

Task Parameter, used both in the equality and inequality task. More...

#include <TPIKDefines.h>

Public Member Functions

bool ConfigureFromFile (const libconfig::Setting &confObj) noexcept(false)
 

Public Attributes

bool taskEnable = false
 Boolean stating whether the task is active.
 
double gain = 0.0
 The reference gain used in calculation.
 
double conf_gain = 0.0
 A backup variable for reference gain loaded from the configuration file.
 
double saturation = 0.0
 The reference saturation value.
 
double conf_saturation = 0.0
 A backup variable for reference saturation loaded from the configuration file.
 

Friends

std::ostream & operator<< (std::ostream &os, TaskParameter const &taskParam)
 Overload of the cout operator.
 

Detailed Description

Task Parameter, used both in the equality and inequality task.

Member Function Documentation

◆ ConfigureFromFile()

bool tpik::TaskParameter::ConfigureFromFile ( const libconfig::Setting &  confObj)
inline

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
TaskParameter const &  taskParam 
)
friend

Overload of the cout operator.

Member Data Documentation

◆ conf_gain

double tpik::TaskParameter::conf_gain = 0.0

A backup variable for reference gain loaded from the configuration file.

◆ conf_saturation

double tpik::TaskParameter::conf_saturation = 0.0

A backup variable for reference saturation loaded from the configuration file.

◆ gain

double tpik::TaskParameter::gain = 0.0

The reference gain used in calculation.

◆ saturation

double tpik::TaskParameter::saturation = 0.0

The reference saturation value.

◆ taskEnable

bool tpik::TaskParameter::taskEnable = false

Boolean stating whether the task is active.


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