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

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

#include <networkWrappers/battery_nws_yarp/Battery_nws_yarp_ParamsParser.h>

+ Inheritance diagram for Battery_nws_yarp_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 Battery_nws_yarp_ParamsParser ()
 
 ~Battery_nws_yarp_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_yarp"}
 
const std::string m_device_name = {"battery_nws_yarp"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_name_defaultValue = {"/robotName/battery1"}
 
const std::string m_period_defaultValue = {"1.0"}
 
const std::string m_enable_shutdown_defaultValue = {"false"}
 
const std::string m_enable_log_defaultValue = {"false"}
 
const std::string m_quitPortName_defaultValue = {""}
 
std::string m_name = {"/robotName/battery1"}
 
double m_period = {1.0}
 
bool m_enable_shutdown = {false}
 
bool m_enable_log = {false}
 
std::string m_quitPortName = {}
 

Detailed Description

This class is the parameters parser for class Battery_nws_yarp.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- name string - /robotName/battery1 1 prefix of the ports opened by the device MUST start with a '/' character. /data:o and /rpc:i is automatically appended by the wrapper at the end
- period double s 1.0 0 refresh period of the broadcasted values in seconds optional, default 1.0s
- enable_shutdown bool - false 0 if enabled, batteryWrapper will start a system shutdown when charge is below 5% -
- enable_log bool - false 0 if enabled, stores a log of battery usage on disk data stored on file batteryLog.txt
- quitPortName string - - 0 if present, this yarp port will be opened and used to send a sthutdown command to other processes enable_shutdown must be enabled

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

yarpdev --device battery_nws_yarp --name /robotName/battery1 --period 1.0 --enable_shutdown false --enable_log false --quitPortName <optional_value>
yarpdev --device battery_nws_yarp --name /robotName/battery1

Definition at line 45 of file Battery_nws_yarp_ParamsParser.h.

Constructor & Destructor Documentation

◆ Battery_nws_yarp_ParamsParser()

Battery_nws_yarp_ParamsParser::Battery_nws_yarp_ParamsParser ( )

Definition at line 23 of file Battery_nws_yarp_ParamsParser.cpp.

◆ ~Battery_nws_yarp_ParamsParser()

Battery_nws_yarp_ParamsParser::~Battery_nws_yarp_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getDeviceClassName()

std::string Battery_nws_yarp_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 75 of file Battery_nws_yarp_ParamsParser.h.

◆ getDeviceName()

std::string Battery_nws_yarp_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 76 of file Battery_nws_yarp_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string Battery_nws_yarp_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 151 of file Battery_nws_yarp_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > Battery_nws_yarp_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_yarp_ParamsParser.cpp.

◆ parseParams()

bool Battery_nws_yarp_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 40 of file Battery_nws_yarp_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string Battery_nws_yarp_ParamsParser::m_device_classname = {"Battery_nws_yarp"}

Definition at line 52 of file Battery_nws_yarp_ParamsParser.h.

◆ m_device_name

const std::string Battery_nws_yarp_ParamsParser::m_device_name = {"battery_nws_yarp"}

Definition at line 53 of file Battery_nws_yarp_ParamsParser.h.

◆ m_enable_log

bool Battery_nws_yarp_ParamsParser::m_enable_log = {false}

Definition at line 71 of file Battery_nws_yarp_ParamsParser.h.

◆ m_enable_log_defaultValue

const std::string Battery_nws_yarp_ParamsParser::m_enable_log_defaultValue = {"false"}

Definition at line 65 of file Battery_nws_yarp_ParamsParser.h.

◆ m_enable_shutdown

bool Battery_nws_yarp_ParamsParser::m_enable_shutdown = {false}

Definition at line 70 of file Battery_nws_yarp_ParamsParser.h.

◆ m_enable_shutdown_defaultValue

const std::string Battery_nws_yarp_ParamsParser::m_enable_shutdown_defaultValue = {"false"}

Definition at line 64 of file Battery_nws_yarp_ParamsParser.h.

◆ m_name

std::string Battery_nws_yarp_ParamsParser::m_name = {"/robotName/battery1"}

Definition at line 68 of file Battery_nws_yarp_ParamsParser.h.

◆ m_name_defaultValue

const std::string Battery_nws_yarp_ParamsParser::m_name_defaultValue = {"/robotName/battery1"}

Definition at line 62 of file Battery_nws_yarp_ParamsParser.h.

◆ m_parser_is_strict

bool Battery_nws_yarp_ParamsParser::m_parser_is_strict = false

Definition at line 54 of file Battery_nws_yarp_ParamsParser.h.

◆ m_parser_version

const parser_version_type Battery_nws_yarp_ParamsParser::m_parser_version = {}

Definition at line 60 of file Battery_nws_yarp_ParamsParser.h.

◆ m_period

double Battery_nws_yarp_ParamsParser::m_period = {1.0}

Definition at line 69 of file Battery_nws_yarp_ParamsParser.h.

◆ m_period_defaultValue

const std::string Battery_nws_yarp_ParamsParser::m_period_defaultValue = {"1.0"}

Definition at line 63 of file Battery_nws_yarp_ParamsParser.h.

◆ m_quitPortName

std::string Battery_nws_yarp_ParamsParser::m_quitPortName = {}

Definition at line 72 of file Battery_nws_yarp_ParamsParser.h.

◆ m_quitPortName_defaultValue

const std::string Battery_nws_yarp_ParamsParser::m_quitPortName_defaultValue = {""}

Definition at line 66 of file Battery_nws_yarp_ParamsParser.h.

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