RawValuesPublisherServer_ParamsParser Class Reference

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

#include <RawValuesPublisherServer_ParamsParser.h>

Inheritance diagram for RawValuesPublisherServer_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	RawValuesPublisherServer_ParamsParser ()
	~RawValuesPublisherServer_ParamsParser ()=default
bool	parseParams (const yarp::os::Searchable &config)
std::string	getDeviceClassName () const
std::string	getDeviceName () const
std::string	getDocumentationOfDeviceParams () const
std::vector< std::string >	getListOfParams () const

Public Attributes
const std::string	m_device_classname = {"RawValuesPublisherServer"}
const std::string	m_device_name = {"rawValuesPublisherServer"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_name_defaultValue = {""}
const std::string	m_period_defaultValue = {""}
std::string	m_name = {}
int	m_period = {0}

Detailed Description

This class is the parameters parser for class RawValuesPublisherServer.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	name	string	-	-	1	Prefix of the port opened by this device	MUST start with a '/' character
-	period	int	ms	-	1	Refresh period of the broadcasted values in ms	-

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

yarpdev --device rawValuesPublisherServer --name <mandatory_value> --period <mandatory_value>

yarpdev --device rawValuesPublisherServer --name <mandatory_value> --period <mandatory_value>

Definition at line 45 of file RawValuesPublisherServer_ParamsParser.h.

Constructor & Destructor Documentation

RawValuesPublisherServer_ParamsParser()

RawValuesPublisherServer_ParamsParser::RawValuesPublisherServer_ParamsParser

(

)

Definition at line 23 of file RawValuesPublisherServer_ParamsParser.cpp.

~RawValuesPublisherServer_ParamsParser()

RawValuesPublisherServer_ParamsParser::~RawValuesPublisherServer_ParamsParser ( )

default

Member Function Documentation

getDeviceClassName()

std::string RawValuesPublisherServer_ParamsParser::getDeviceClassName ( ) const

inline

Definition at line 69 of file RawValuesPublisherServer_ParamsParser.h.

getDeviceName()

std::string RawValuesPublisherServer_ParamsParser::getDeviceName ( ) const

inline

Definition at line 70 of file RawValuesPublisherServer_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string RawValuesPublisherServer_ParamsParser::getDocumentationOfDeviceParams

(

)

const

Definition at line 109 of file RawValuesPublisherServer_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > RawValuesPublisherServer_ParamsParser::getListOfParams

(

)

const

Definition at line 28 of file RawValuesPublisherServer_ParamsParser.cpp.

parseParams()

bool RawValuesPublisherServer_ParamsParser::parseParams

(

const yarp::os::Searchable &

config

)

Definition at line 37 of file RawValuesPublisherServer_ParamsParser.cpp.

Member Data Documentation

m_device_classname

const std::string RawValuesPublisherServer_ParamsParser::m_device_classname = {"RawValuesPublisherServer"}

Definition at line 52 of file RawValuesPublisherServer_ParamsParser.h.

m_device_name

const std::string RawValuesPublisherServer_ParamsParser::m_device_name = {"rawValuesPublisherServer"}

Definition at line 53 of file RawValuesPublisherServer_ParamsParser.h.

m_name

std::string RawValuesPublisherServer_ParamsParser::m_name = {}

Definition at line 65 of file RawValuesPublisherServer_ParamsParser.h.

m_name_defaultValue

const std::string RawValuesPublisherServer_ParamsParser::m_name_defaultValue = {""}

Definition at line 62 of file RawValuesPublisherServer_ParamsParser.h.

m_parser_is_strict

bool RawValuesPublisherServer_ParamsParser::m_parser_is_strict = false

Definition at line 54 of file RawValuesPublisherServer_ParamsParser.h.

m_parser_version

const parser_version_type RawValuesPublisherServer_ParamsParser::m_parser_version = {}

Definition at line 60 of file RawValuesPublisherServer_ParamsParser.h.

m_period

int RawValuesPublisherServer_ParamsParser::m_period = {0}

Definition at line 66 of file RawValuesPublisherServer_ParamsParser.h.

m_period_defaultValue

const std::string RawValuesPublisherServer_ParamsParser::m_period_defaultValue = {""}

Definition at line 63 of file RawValuesPublisherServer_ParamsParser.h.

---

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

• icub-main/src/libraries/icubmod/rawValuesPublisherServer/RawValuesPublisherServer_ParamsParser.h
• icub-main/src/libraries/icubmod/rawValuesPublisherServer/RawValuesPublisherServer_ParamsParser.cpp