#include <CanBusSocket_ParamsParser.h>

Inheritance diagram for CanBusSocket_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 = {"CanBusSocket"}

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

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

const std::string	m_port_defaultValue = {"can0"}

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

const std::string	m_blockingMode_defaultValue = {"true"}

const std::string	m_allowPermissive_defaultValue = {"false"}

const std::string	m_rxTimeoutMs_defaultValue = {"1"}

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

const std::string	m_filterFunctionCodes_defaultValue = {"true"}

const std::string	m_filteredIds_defaultValue = {""}

std::string	m_port = {"can0"}

int	m_bitrate = {0}

bool	m_blockingMode = {true}

bool	m_allowPermissive = {false}

int	m_rxTimeoutMs = {1}

int	m_txTimeoutMs = {0}

bool	m_filterFunctionCodes = {true}

std::vector< int >	m_filteredIds = {}

Detailed Description

This class is the parameters parser for class CanBusSocket.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Description	Notes
-	port	string	-	can0	CAN socket interface	-
-	bitrate	int	bps	0	CAN bitrate	-
-	blockingMode	bool	-	true	blocking mode enabled	-
-	allowPermissive	bool	-	false	read/write permissive mode	-
-	rxTimeoutMs	int	ms	1	RX timeout	-
-	txTimeoutMs	int	ms	0	TX timeout	-
-	filterFunctionCodes	bool	-	true	filter mask ignores CANopen function codes	-
-	filteredIds	vector<int>	-	-	filtered node IDs	-

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

yarpdev --device CanBusSocket --port can0 --bitrate 0 --blockingMode true --allowPermissive false --rxTimeoutMs 1 --txTimeoutMs 0 --filterFunctionCodes true --filteredIds <optional_value>

yarpdev --device CanBusSocket

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

libraries/YarpPlugins/CanBusSocket/CanBusSocket_ParamsParser.h
libraries/YarpPlugins/CanBusSocket/CanBusSocket_ParamsParser.cpp

Classes

Public Member Functions

Public Attributes

Detailed Description