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

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

#include <fake/fakeMotionControlMicro/FakeMotionControlMicro_ParamsParser.h>

+ Inheritance diagram for FakeMotionControlMicro_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 FakeMotionControlMicro_ParamsParser ()
 
 ~FakeMotionControlMicro_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.
 
bool getParamValue (const std::string &paramName, std::string &paramValue) const override
 Return the value (represented as a string) of the requested parameter.
 
std::string getConfiguration () const override
 Return the configuration of the device.
 
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()
 

Public Attributes

const std::string m_device_classname = {"FakeMotionControlMicro"}
 
const std::string m_device_name = {"fakeMotionControlMicro"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
std::string m_provided_configuration
 
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_Encoder_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< int > m_GENERAL_Encoder = {}
 

Detailed Description

This class is the parameters parser for class FakeMotionControlMicro.

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 Encoder vector<int> - - 0 a list of scales for the encoders -

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

yarpdev --device fakeMotionControlMicro --GENERAL::Joints 1 --GENERAL::AxisMap <optional_value> --GENERAL::AxisName <optional_value> --GENERAL::AxisType <optional_value> --GENERAL::Encoder <optional_value>
yarpdev --device fakeMotionControlMicro

Definition at line 45 of file FakeMotionControlMicro_ParamsParser.h.

Constructor & Destructor Documentation

◆ FakeMotionControlMicro_ParamsParser()

FakeMotionControlMicro_ParamsParser::FakeMotionControlMicro_ParamsParser ( )

Definition at line 23 of file FakeMotionControlMicro_ParamsParser.cpp.

◆ ~FakeMotionControlMicro_ParamsParser()

FakeMotionControlMicro_ParamsParser::~FakeMotionControlMicro_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getConfiguration()

std::string FakeMotionControlMicro_ParamsParser::getConfiguration ( ) const
overridevirtual

Return the configuration of the device.

Returns
The configuration of the device, represented in a string format.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 70 of file FakeMotionControlMicro_ParamsParser.cpp.

◆ getDeviceClassName()

std::string FakeMotionControlMicro_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 77 of file FakeMotionControlMicro_ParamsParser.h.

◆ getDeviceName()

std::string FakeMotionControlMicro_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 78 of file FakeMotionControlMicro_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string FakeMotionControlMicro_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 259 of file FakeMotionControlMicro_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > FakeMotionControlMicro_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 FakeMotionControlMicro_ParamsParser.cpp.

◆ getParamValue()

bool FakeMotionControlMicro_ParamsParser::getParamValue ( const std::string &  paramName,
std::string &  paramValue 
) const
overridevirtual

Return the value (represented as a string) of the requested parameter.

Returns
True if the requested parameter was succesfully retrieved.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 40 of file FakeMotionControlMicro_ParamsParser.cpp.

◆ parseParams()

bool FakeMotionControlMicro_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 80 of file FakeMotionControlMicro_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string FakeMotionControlMicro_ParamsParser::m_device_classname = {"FakeMotionControlMicro"}

Definition at line 52 of file FakeMotionControlMicro_ParamsParser.h.

◆ m_device_name

const std::string FakeMotionControlMicro_ParamsParser::m_device_name = {"fakeMotionControlMicro"}

Definition at line 53 of file FakeMotionControlMicro_ParamsParser.h.

◆ m_GENERAL_AxisMap

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

Definition at line 71 of file FakeMotionControlMicro_ParamsParser.h.

◆ m_GENERAL_AxisMap_defaultValue

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

Definition at line 65 of file FakeMotionControlMicro_ParamsParser.h.

◆ m_GENERAL_AxisName

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

Definition at line 72 of file FakeMotionControlMicro_ParamsParser.h.

◆ m_GENERAL_AxisName_defaultValue

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

Definition at line 66 of file FakeMotionControlMicro_ParamsParser.h.

◆ m_GENERAL_AxisType

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

Definition at line 73 of file FakeMotionControlMicro_ParamsParser.h.

◆ m_GENERAL_AxisType_defaultValue

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

Definition at line 67 of file FakeMotionControlMicro_ParamsParser.h.

◆ m_GENERAL_Encoder

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

Definition at line 74 of file FakeMotionControlMicro_ParamsParser.h.

◆ m_GENERAL_Encoder_defaultValue

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

Definition at line 68 of file FakeMotionControlMicro_ParamsParser.h.

◆ m_GENERAL_Joints

int FakeMotionControlMicro_ParamsParser::m_GENERAL_Joints = {1}

Definition at line 70 of file FakeMotionControlMicro_ParamsParser.h.

◆ m_GENERAL_Joints_defaultValue

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

Definition at line 64 of file FakeMotionControlMicro_ParamsParser.h.

◆ m_parser_is_strict

bool FakeMotionControlMicro_ParamsParser::m_parser_is_strict = false

Definition at line 54 of file FakeMotionControlMicro_ParamsParser.h.

◆ m_parser_version

const parser_version_type FakeMotionControlMicro_ParamsParser::m_parser_version = {}

Definition at line 60 of file FakeMotionControlMicro_ParamsParser.h.

◆ m_provided_configuration

std::string FakeMotionControlMicro_ParamsParser::m_provided_configuration

Definition at line 62 of file FakeMotionControlMicro_ParamsParser.h.

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