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

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

#include <networkWrappers/frameGrabber_nws_yarp/FrameGrabber_nws_yarp_ParamsParser.h>

+ Inheritance diagram for FrameGrabber_nws_yarp_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 FrameGrabber_nws_yarp_ParamsParser ()
 
 ~FrameGrabber_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.
 
bool getParamValue (const std::string &paramName, std::string &paramValue) const override
 Return the value (represented as a string) of the requested parameter.
 
std::string getConfiguration () const override
 Return the configuration of the device.
 
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()
 

Public Attributes

const std::string m_device_classname = {"FrameGrabber_nws_yarp"}
 
const std::string m_device_name = {"frameGrabber_nws_yarp"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
std::string m_provided_configuration
 
const std::string m_period_defaultValue = {"0.033"}
 
const std::string m_name_defaultValue = {"/grabber"}
 
const std::string m_capabilities_defaultValue = {"COLOR"}
 
const std::string m_no_drop_defaultValue = {"true"}
 
double m_period = {0.033}
 
std::string m_name = {"/grabber"}
 
std::string m_capabilities = {"COLOR"}
 
bool m_no_drop = {true}
 

Detailed Description

This class is the parameters parser for class FrameGrabber_nws_yarp.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- period double s 0.033 0 refresh period (in s) of the broadcasted values through yarp ports default 0.03s
- name string - /grabber 0 Prefix name of the ports opened by the FrameGrabber_nws_yarp Required suffix like '/rpc' will be added by the device
- capabilities string - COLOR 0 two capabilities supported, COLOR and RAW respectively for rgb and raw streaming -
- no_drop bool - true 0 if present, use strict policy for sending data -

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

yarpdev --device frameGrabber_nws_yarp --period 0.033 --name /grabber --capabilities COLOR --no_drop true
yarpdev --device frameGrabber_nws_yarp

Definition at line 44 of file FrameGrabber_nws_yarp_ParamsParser.h.

Constructor & Destructor Documentation

◆ FrameGrabber_nws_yarp_ParamsParser()

FrameGrabber_nws_yarp_ParamsParser::FrameGrabber_nws_yarp_ParamsParser ( )

Definition at line 23 of file FrameGrabber_nws_yarp_ParamsParser.cpp.

◆ ~FrameGrabber_nws_yarp_ParamsParser()

FrameGrabber_nws_yarp_ParamsParser::~FrameGrabber_nws_yarp_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getConfiguration()

std::string FrameGrabber_nws_yarp_ParamsParser::getConfiguration ( ) const
overridevirtual

Return the configuration of the device.

Returns
The configuration of the device, represented in a string format.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 69 of file FrameGrabber_nws_yarp_ParamsParser.cpp.

◆ getDeviceClassName()

std::string FrameGrabber_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 74 of file FrameGrabber_nws_yarp_ParamsParser.h.

◆ getDeviceName()

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

◆ getDocumentationOfDeviceParams()

std::string FrameGrabber_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 174 of file FrameGrabber_nws_yarp_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > FrameGrabber_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 FrameGrabber_nws_yarp_ParamsParser.cpp.

◆ getParamValue()

bool FrameGrabber_nws_yarp_ParamsParser::getParamValue ( const std::string &  paramName,
std::string &  paramValue 
) const
overridevirtual

Return the value (represented as a string) of the requested parameter.

Returns
True if the requested parameter was succesfully retrieved.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 39 of file FrameGrabber_nws_yarp_ParamsParser.cpp.

◆ parseParams()

bool FrameGrabber_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 79 of file FrameGrabber_nws_yarp_ParamsParser.cpp.

Member Data Documentation

◆ m_capabilities

std::string FrameGrabber_nws_yarp_ParamsParser::m_capabilities = {"COLOR"}

Definition at line 70 of file FrameGrabber_nws_yarp_ParamsParser.h.

◆ m_capabilities_defaultValue

const std::string FrameGrabber_nws_yarp_ParamsParser::m_capabilities_defaultValue = {"COLOR"}

Definition at line 65 of file FrameGrabber_nws_yarp_ParamsParser.h.

◆ m_device_classname

const std::string FrameGrabber_nws_yarp_ParamsParser::m_device_classname = {"FrameGrabber_nws_yarp"}

Definition at line 51 of file FrameGrabber_nws_yarp_ParamsParser.h.

◆ m_device_name

const std::string FrameGrabber_nws_yarp_ParamsParser::m_device_name = {"frameGrabber_nws_yarp"}

Definition at line 52 of file FrameGrabber_nws_yarp_ParamsParser.h.

◆ m_name

std::string FrameGrabber_nws_yarp_ParamsParser::m_name = {"/grabber"}

Definition at line 69 of file FrameGrabber_nws_yarp_ParamsParser.h.

◆ m_name_defaultValue

const std::string FrameGrabber_nws_yarp_ParamsParser::m_name_defaultValue = {"/grabber"}

Definition at line 64 of file FrameGrabber_nws_yarp_ParamsParser.h.

◆ m_no_drop

bool FrameGrabber_nws_yarp_ParamsParser::m_no_drop = {true}

Definition at line 71 of file FrameGrabber_nws_yarp_ParamsParser.h.

◆ m_no_drop_defaultValue

const std::string FrameGrabber_nws_yarp_ParamsParser::m_no_drop_defaultValue = {"true"}

Definition at line 66 of file FrameGrabber_nws_yarp_ParamsParser.h.

◆ m_parser_is_strict

bool FrameGrabber_nws_yarp_ParamsParser::m_parser_is_strict = false

Definition at line 53 of file FrameGrabber_nws_yarp_ParamsParser.h.

◆ m_parser_version

const parser_version_type FrameGrabber_nws_yarp_ParamsParser::m_parser_version = {}

Definition at line 59 of file FrameGrabber_nws_yarp_ParamsParser.h.

◆ m_period

double FrameGrabber_nws_yarp_ParamsParser::m_period = {0.033}

Definition at line 68 of file FrameGrabber_nws_yarp_ParamsParser.h.

◆ m_period_defaultValue

const std::string FrameGrabber_nws_yarp_ParamsParser::m_period_defaultValue = {"0.033"}

Definition at line 63 of file FrameGrabber_nws_yarp_ParamsParser.h.

◆ m_provided_configuration

std::string FrameGrabber_nws_yarp_ParamsParser::m_provided_configuration

Definition at line 61 of file FrameGrabber_nws_yarp_ParamsParser.h.

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