#include <RealToSimControlBoard_ParamsParser.h>

Inheritance diagram for RealToSimControlBoard_ParamsParser:

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 = {"RealToSimControlBoard"}

const std::string	m_device_name = {"RealToSimControlBoard"}

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

const std::string	m_modePosVel_defaultValue = {"0"}

const std::string	m_remotes_defaultValue = {""}

const std::string	m_remotePrefix_defaultValue = {""}

const std::string	m_remoteSuffix_defaultValue = {""}

const std::string	m_localSuffix_defaultValue = {""}

int	m_modePosVel = {0}

std::vector< std::string >	m_remotes = {}

std::string	m_remotePrefix = {}

std::string	m_remoteSuffix = {}

std::string	m_localSuffix = {}

Detailed Description

This class is the parameters parser for class RealToSimControlBoard.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	modePosVel	int	-	0	0	position or velocity mode	0: pos, 1: vel
-	remotes	vector<string>	-	-	1	list of remotes to which this device connects	-
-	remotePrefix	string	-	-	0	global prefix to remote ports	-
-	remoteSuffix	string	-	-	0	suffix for remote port of each remote_controlboard	-
-	localSuffix	string	-	-	0	suffix for local port of each remote_controlboard	-

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

yarpdev --device RealToSimControlBoard --modePosVel 0 --remotes <mandatory_value> --remotePrefix <optional_value> --remoteSuffix <optional_value> --localSuffix <optional_value>

yarpdev --device RealToSimControlBoard --remotes <mandatory_value>

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

libraries/YarpPlugins/RealToSimControlBoard/RealToSimControlBoard_ParamsParser.h
libraries/YarpPlugins/RealToSimControlBoard/RealToSimControlBoard_ParamsParser.cpp

Classes

Public Member Functions

Public Attributes

Detailed Description