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

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

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-devices-ros2/src/devices/battery_nws_ros2/Battery_nws_ros2_ParamsParser.h>

+ Inheritance diagram for Battery_nws_ros2_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 Battery_nws_ros2_ParamsParser ()
 
 ~Battery_nws_ros2_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.
 
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()
 

Public Attributes

const std::string m_device_classname = {"Battery_nws_ros2"}
 
const std::string m_device_name = {"battery_nws_ros2"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_period_defaultValue = {"0.02"}
 
const std::string m_node_name_defaultValue = {""}
 
const std::string m_topic_name_defaultValue = {""}
 
double m_period = {0.02}
 
std::string m_node_name = {}
 
std::string m_topic_name = {}
 

Detailed Description

This class is the parameters parser for class Battery_nws_ros2.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- period double s 0.02 0 refresh period of the broadcasted values in s default 0.02s
- node_name string - - 1 name of the ros2 node -
- topic_name string - - 1 name of the topic where the device must publish the data must begin with an initial '/'

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

yarpdev --device battery_nws_ros2 --period 0.02 --node_name <mandatory_value> --topic_name <mandatory_value>
yarpdev --device battery_nws_ros2 --node_name <mandatory_value> --topic_name <mandatory_value>

Definition at line 43 of file Battery_nws_ros2_ParamsParser.h.

Constructor & Destructor Documentation

◆ Battery_nws_ros2_ParamsParser()

Battery_nws_ros2_ParamsParser::Battery_nws_ros2_ParamsParser ( )

Definition at line 23 of file Battery_nws_ros2_ParamsParser.cpp.

◆ ~Battery_nws_ros2_ParamsParser()

Battery_nws_ros2_ParamsParser::~Battery_nws_ros2_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getDeviceClassName()

std::string Battery_nws_ros2_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 69 of file Battery_nws_ros2_ParamsParser.h.

◆ getDeviceName()

std::string Battery_nws_ros2_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 70 of file Battery_nws_ros2_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string Battery_nws_ros2_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 123 of file Battery_nws_ros2_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > Battery_nws_ros2_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 Battery_nws_ros2_ParamsParser.cpp.

◆ parseParams()

bool Battery_nws_ros2_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 38 of file Battery_nws_ros2_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string Battery_nws_ros2_ParamsParser::m_device_classname = {"Battery_nws_ros2"}

Definition at line 50 of file Battery_nws_ros2_ParamsParser.h.

◆ m_device_name

const std::string Battery_nws_ros2_ParamsParser::m_device_name = {"battery_nws_ros2"}

Definition at line 51 of file Battery_nws_ros2_ParamsParser.h.

◆ m_node_name

std::string Battery_nws_ros2_ParamsParser::m_node_name = {}

Definition at line 65 of file Battery_nws_ros2_ParamsParser.h.

◆ m_node_name_defaultValue

const std::string Battery_nws_ros2_ParamsParser::m_node_name_defaultValue = {""}

Definition at line 61 of file Battery_nws_ros2_ParamsParser.h.

◆ m_parser_is_strict

bool Battery_nws_ros2_ParamsParser::m_parser_is_strict = false

Definition at line 52 of file Battery_nws_ros2_ParamsParser.h.

◆ m_parser_version

const parser_version_type Battery_nws_ros2_ParamsParser::m_parser_version = {}

Definition at line 58 of file Battery_nws_ros2_ParamsParser.h.

◆ m_period

double Battery_nws_ros2_ParamsParser::m_period = {0.02}

Definition at line 64 of file Battery_nws_ros2_ParamsParser.h.

◆ m_period_defaultValue

const std::string Battery_nws_ros2_ParamsParser::m_period_defaultValue = {"0.02"}

Definition at line 60 of file Battery_nws_ros2_ParamsParser.h.

◆ m_topic_name

std::string Battery_nws_ros2_ParamsParser::m_topic_name = {}

Definition at line 66 of file Battery_nws_ros2_ParamsParser.h.

◆ m_topic_name_defaultValue

const std::string Battery_nws_ros2_ParamsParser::m_topic_name_defaultValue = {""}

Definition at line 62 of file Battery_nws_ros2_ParamsParser.h.

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