yarp-devices
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
JointCalibrator_ParamsParser Class Reference

#include <JointCalibrator_ParamsParser.h>

Inheritance diagram for JointCalibrator_ParamsParser:
JointCalibrator

Classes

struct  parser_version_type
 

Public Member Functions

bool parseParams (const yarp::os::Searchable &config) override
 
std::string getDeviceClassName () const override
 
std::string getDeviceName () const override
 
std::string getDocumentationOfDeviceParams () const override
 
std::vector< std::string > getListOfParams () const override
 

Public Attributes

const std::string m_device_classname = {"JointCalibrator"}
 
const std::string m_device_name = {"JointCalibrator"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_joints_defaultValue = {"0"}
 
const std::string m_block_defaultValue = {"false"}
 
const std::string m_home_defaultValue = {"0.0"}
 
const std::string m_homeVel_defaultValue = {"0.0"}
 
const std::string m_homeAcc_defaultValue = {"0.0"}
 
const std::string m_park_defaultValue = {"0.0"}
 
const std::string m_parkVel_defaultValue = {"0.0"}
 
const std::string m_parkAcc_defaultValue = {"0.0"}
 
const std::string m_homes_defaultValue = {""}
 
const std::string m_homeVels_defaultValue = {""}
 
const std::string m_homeAccs_defaultValue = {""}
 
const std::string m_parks_defaultValue = {""}
 
const std::string m_parkVels_defaultValue = {""}
 
const std::string m_parkAccs_defaultValue = {""}
 
int m_joints = {0}
 
bool m_block = {false}
 
double m_home = {0.0}
 
double m_homeVel = {0.0}
 
double m_homeAcc = {0.0}
 
double m_park = {0.0}
 
double m_parkVel = {0.0}
 
double m_parkAcc = {0.0}
 
std::vector< double > m_homes = {}
 
std::vector< double > m_homeVels = {}
 
std::vector< double > m_homeAccs = {}
 
std::vector< double > m_parks = {}
 
std::vector< double > m_parkVels = {}
 
std::vector< double > m_parkAccs = {}
 

Detailed Description

This class is the parameters parser for class JointCalibrator.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- joints int - 0 0 number of controlled axes -
- block bool - false 0 commands should block -
- home double deg 0.0 0 zero position (global) -
- homeVel double deg/s 0.0 0 zero velocity (global) -
- homeAcc double deg/s^2 0.0 0 zero acceleration (global) -
- park double deg 0.0 0 park position (global) -
- parkVel double deg/s 0.0 0 park velocity (global) -
- parkAcc double deg/s^2 0.0 0 park acceleration (global) -
- homes vector<double> deg - 0 zero position (individual) -
- homeVels vector<double> deg/s - 0 zero velocity (individual) -
- homeAccs vector<double> deg/s^2 - 0 zero acceleration (individual) -
- parks vector<double> deg - 0 park position (individual) -
- parkVels vector<double> deg/s - 0 park velocity (individual) -
- parkAccs vector<double> deg/s^2 - 0 park acceleration (individual) -

The device can be launched by yarpdev using one of the following examples (with and without all optional parameters):

yarpdev --device JointCalibrator --joints 0 --block false --home 0.0 --homeVel 0.0 --homeAcc 0.0 --park 0.0 --parkVel 0.0 --parkAcc 0.0 --homes <optional_value> --homeVels <optional_value> --homeAccs <optional_value> --parks <optional_value> --parkVels <optional_value> --parkAccs <optional_value>
yarpdev --device JointCalibrator

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