#include <CuiAbsolute_ParamsParser.h>

Inheritance diagram for CuiAbsolute_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 = {"CuiAbsolute"}

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

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

const std::string	m_canId_defaultValue = {""}

const std::string	m_reverse_defaultValue = {""}

const std::string	m_timeout_defaultValue = {"0.25"}

const std::string	m_maxRetries_defaultValue = {"10"}

const std::string	m_mode_defaultValue = {""}

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

int	m_canId = {0}

bool	m_reverse = {false}

double	m_timeout = {0.25}

int	m_maxRetries = {10}

std::string	m_mode = {}

int	m_pushDelay = {0}

Detailed Description

This class is the parameters parser for class CuiAbsolute.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	canId	int	-	-	1	CAN bus ID	1-127
-	reverse	bool	-	-	1	reverse counting	-
-	timeout	double	s	0.25	0	acquisition timeout	-
-	maxRetries	int	-	10	0	maximum number of retries on timeout	-
-	mode	string	-	-	1	publish mode	push, pull
-	pushDelay	int	-	0	0	push mode delay	0-255

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

yarpdev --device CuiAbsolute --canId <mandatory_value> --reverse <mandatory_value> --timeout 0.25 --maxRetries 10 --mode <mandatory_value> --pushDelay 0

yarpdev --device CuiAbsolute --canId <mandatory_value> --reverse <mandatory_value> --mode <mandatory_value>

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

libraries/YarpPlugins/CuiAbsolute/CuiAbsolute_ParamsParser.h
libraries/YarpPlugins/CuiAbsolute/CuiAbsolute_ParamsParser.cpp

Classes

Public Member Functions

Public Attributes

Detailed Description