YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
FakeMotionControl_ParamsParser Class Reference

This class is the parameters parser for class FakeMotionControl. More...

#include <fake/fakeMotionControl/FakeMotionControl_ParamsParser.h>

+ Inheritance diagram for FakeMotionControl_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 FakeMotionControl_ParamsParser ()
 
 ~FakeMotionControl_ParamsParser () override=default
 
bool parseParams (const yarp::os::Searchable &config) override
 Parse the DeviceDriver parameters.
 
std::string getDeviceClassName () const override
 Get the name of the DeviceDriver class.
 
std::string getDeviceName () const override
 Get the name of the device (i.e.
 
std::string getDocumentationOfDeviceParams () const override
 Get the documentation of the DeviceDriver's parameters.
 
std::vector< std::string > getListOfParams () const override
 Return a list of all params used by the device.
 
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()
 

Public Attributes

const std::string m_device_classname = {"FakeMotionControl"}
 
const std::string m_device_name = {"fakeMotionControl"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_GENERAL_Joints_defaultValue = {"1"}
 
const std::string m_GENERAL_AxisMap_defaultValue = {""}
 
const std::string m_GENERAL_AxisName_defaultValue = {""}
 
const std::string m_GENERAL_AxisType_defaultValue = {""}
 
const std::string m_GENERAL_ampsToSensor_defaultValue = {""}
 
const std::string m_GENERAL_fullscalePWM_defaultValue = {""}
 
const std::string m_GENERAL_Encoder_defaultValue = {""}
 
const std::string m_LIMITS_Max_defaultValue = {""}
 
const std::string m_LIMITS_Min_defaultValue = {""}
 
int m_GENERAL_Joints = {1}
 
std::vector< int > m_GENERAL_AxisMap = {}
 
std::vector< std::string > m_GENERAL_AxisName = {}
 
std::vector< std::string > m_GENERAL_AxisType = {}
 
std::vector< double > m_GENERAL_ampsToSensor = {}
 
std::vector< double > m_GENERAL_fullscalePWM = {}
 
std::vector< int > m_GENERAL_Encoder = {}
 
std::vector< double > m_LIMITS_Max = {}
 
std::vector< double > m_LIMITS_Min = {}
 

Detailed Description

This class is the parameters parser for class FakeMotionControl.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
GENERAL Joints int - 1 0 Number of degrees of freedom -
GENERAL AxisMap vector<int> - - 0 a list of reordered indices for the axes -
GENERAL AxisName vector<string> - - 0 a list of strings representing the axes names -
GENERAL AxisType vector<string> - - 0 a list of strings representing the axes type (revolute/prismatic) -
GENERAL ampsToSensor vector<double> - - 0 a list of scales for the ampsToSensor conversion factors -
GENERAL fullscalePWM vector<double> - - 0 a list of scales for the fullscalePWM conversion factors -
GENERAL Encoder vector<int> - - 0 a list of scales for the encoders -
LIMITS Max vector<double> deg - 0 max encoder position -
LIMITS Min vector<double> deg - 0 min encoder position -

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

yarpdev --device fakeMotionControl --GENERAL::Joints 1 --GENERAL::AxisMap <optional_value> --GENERAL::AxisName <optional_value> --GENERAL::AxisType <optional_value> --GENERAL::ampsToSensor <optional_value> --GENERAL::fullscalePWM <optional_value> --GENERAL::Encoder <optional_value> --LIMITS::Max <optional_value> --LIMITS::Min <optional_value>
yarpdev --device fakeMotionControl

Definition at line 49 of file FakeMotionControl_ParamsParser.h.

Constructor & Destructor Documentation

◆ FakeMotionControl_ParamsParser()

FakeMotionControl_ParamsParser::FakeMotionControl_ParamsParser ( )

Definition at line 23 of file FakeMotionControl_ParamsParser.cpp.

◆ ~FakeMotionControl_ParamsParser()

FakeMotionControl_ParamsParser::~FakeMotionControl_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getDeviceClassName()

std::string FakeMotionControl_ParamsParser::getDeviceClassName ( ) const
inlineoverridevirtual

Get the name of the DeviceDriver class.

Returns
A string containing the name of the class.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 87 of file FakeMotionControl_ParamsParser.h.

◆ getDeviceName()

std::string FakeMotionControl_ParamsParser::getDeviceName ( ) const
inlineoverridevirtual

Get the name of the device (i.e.

the plugin name).

Returns
A string containing the name of the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 88 of file FakeMotionControl_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string FakeMotionControl_ParamsParser::getDocumentationOfDeviceParams ( ) const
overridevirtual

Get the documentation of the DeviceDriver's parameters.

Returns
A string containing the documentation.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 347 of file FakeMotionControl_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > FakeMotionControl_ParamsParser::getListOfParams ( ) const
overridevirtual

Return a list of all params used by the device.

Returns
A vector containing the names of parameters used by the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 28 of file FakeMotionControl_ParamsParser.cpp.

◆ parseParams()

bool FakeMotionControl_ParamsParser::parseParams ( const yarp::os::Searchable &  config)
overridevirtual

Parse the DeviceDriver parameters.

Returns
true if the parsing is successful, false otherwise

Implements yarp::dev::IDeviceDriverParams.

Definition at line 44 of file FakeMotionControl_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string FakeMotionControl_ParamsParser::m_device_classname = {"FakeMotionControl"}

Definition at line 56 of file FakeMotionControl_ParamsParser.h.

◆ m_device_name

const std::string FakeMotionControl_ParamsParser::m_device_name = {"fakeMotionControl"}

Definition at line 57 of file FakeMotionControl_ParamsParser.h.

◆ m_GENERAL_ampsToSensor

std::vector<double> FakeMotionControl_ParamsParser::m_GENERAL_ampsToSensor = {}

Definition at line 80 of file FakeMotionControl_ParamsParser.h.

◆ m_GENERAL_ampsToSensor_defaultValue

const std::string FakeMotionControl_ParamsParser::m_GENERAL_ampsToSensor_defaultValue = {""}

Definition at line 70 of file FakeMotionControl_ParamsParser.h.

◆ m_GENERAL_AxisMap

std::vector<int> FakeMotionControl_ParamsParser::m_GENERAL_AxisMap = {}

Definition at line 77 of file FakeMotionControl_ParamsParser.h.

◆ m_GENERAL_AxisMap_defaultValue

const std::string FakeMotionControl_ParamsParser::m_GENERAL_AxisMap_defaultValue = {""}

Definition at line 67 of file FakeMotionControl_ParamsParser.h.

◆ m_GENERAL_AxisName

std::vector<std::string> FakeMotionControl_ParamsParser::m_GENERAL_AxisName = {}

Definition at line 78 of file FakeMotionControl_ParamsParser.h.

◆ m_GENERAL_AxisName_defaultValue

const std::string FakeMotionControl_ParamsParser::m_GENERAL_AxisName_defaultValue = {""}

Definition at line 68 of file FakeMotionControl_ParamsParser.h.

◆ m_GENERAL_AxisType

std::vector<std::string> FakeMotionControl_ParamsParser::m_GENERAL_AxisType = {}

Definition at line 79 of file FakeMotionControl_ParamsParser.h.

◆ m_GENERAL_AxisType_defaultValue

const std::string FakeMotionControl_ParamsParser::m_GENERAL_AxisType_defaultValue = {""}

Definition at line 69 of file FakeMotionControl_ParamsParser.h.

◆ m_GENERAL_Encoder

std::vector<int> FakeMotionControl_ParamsParser::m_GENERAL_Encoder = {}

Definition at line 82 of file FakeMotionControl_ParamsParser.h.

◆ m_GENERAL_Encoder_defaultValue

const std::string FakeMotionControl_ParamsParser::m_GENERAL_Encoder_defaultValue = {""}

Definition at line 72 of file FakeMotionControl_ParamsParser.h.

◆ m_GENERAL_fullscalePWM

std::vector<double> FakeMotionControl_ParamsParser::m_GENERAL_fullscalePWM = {}

Definition at line 81 of file FakeMotionControl_ParamsParser.h.

◆ m_GENERAL_fullscalePWM_defaultValue

const std::string FakeMotionControl_ParamsParser::m_GENERAL_fullscalePWM_defaultValue = {""}

Definition at line 71 of file FakeMotionControl_ParamsParser.h.

◆ m_GENERAL_Joints

int FakeMotionControl_ParamsParser::m_GENERAL_Joints = {1}

Definition at line 76 of file FakeMotionControl_ParamsParser.h.

◆ m_GENERAL_Joints_defaultValue

const std::string FakeMotionControl_ParamsParser::m_GENERAL_Joints_defaultValue = {"1"}

Definition at line 66 of file FakeMotionControl_ParamsParser.h.

◆ m_LIMITS_Max

std::vector<double> FakeMotionControl_ParamsParser::m_LIMITS_Max = {}

Definition at line 83 of file FakeMotionControl_ParamsParser.h.

◆ m_LIMITS_Max_defaultValue

const std::string FakeMotionControl_ParamsParser::m_LIMITS_Max_defaultValue = {""}

Definition at line 73 of file FakeMotionControl_ParamsParser.h.

◆ m_LIMITS_Min

std::vector<double> FakeMotionControl_ParamsParser::m_LIMITS_Min = {}

Definition at line 84 of file FakeMotionControl_ParamsParser.h.

◆ m_LIMITS_Min_defaultValue

const std::string FakeMotionControl_ParamsParser::m_LIMITS_Min_defaultValue = {""}

Definition at line 74 of file FakeMotionControl_ParamsParser.h.

◆ m_parser_is_strict

bool FakeMotionControl_ParamsParser::m_parser_is_strict = false

Definition at line 58 of file FakeMotionControl_ParamsParser.h.

◆ m_parser_version

const parser_version_type FakeMotionControl_ParamsParser::m_parser_version = {}

Definition at line 64 of file FakeMotionControl_ParamsParser.h.

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