yarp-devices
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
CanBusBroker_ParamsParser Class Reference

#include <CanBusBroker_ParamsParser.h>

Inheritance diagram for CanBusBroker_ParamsParser:
CanBusBroker

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 = {"CanBusBroker"}
 
const std::string m_device_name = {"CanBusBroker"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_buses_defaultValue = {""}
 
const std::string m_syncPeriod_defaultValue = {"0.0"}
 
std::vector< std::string > m_buses = {}
 
double m_syncPeriod = {0.0}
 

Detailed Description

This class is the parameters parser for class CanBusBroker.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- buses vector<string> - - 1 CAN buses -
- syncPeriod double s 0.0 0 synchronization period -

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

yarpdev --device CanBusBroker --buses <mandatory_value> --syncPeriod 0.0
yarpdev --device CanBusBroker --buses <mandatory_value>

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