YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
IDeviceDriverParams.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2023-2023 Istituto Italiano di Tecnologia (IIT)
3 * SPDX-License-Identifier: BSD-3-Clause
4 */
5
6#ifndef YARP_DEV_IDEVICEDRIVERPARAMETERS_H
7#define YARP_DEV_IDEVICEDRIVERPARAMETERS_H
8
9#include <yarp/dev/api.h>
10#include <yarp/os/Searchable.h>
11#include <string>
12
13#include <vector>
14
15namespace yarp::dev {
16 class IDeviceDriverParams;
17}
18
26{
27public:
29
34 virtual bool parseParams(const yarp::os::Searchable& config) = 0;
35
40 virtual std::string getDeviceClassName() const = 0;
41
46 virtual std::string getDeviceName() const = 0;
47
52 virtual std::string getDocumentationOfDeviceParams() const = 0;
53
58 virtual std::vector<std::string> getListOfParams() const = 0;
59
64 virtual bool getParamValue(const std::string& paramName, std::string& paramValue) const = 0;
65
70 virtual std::string getConfiguration() const = 0;
71};
72
73#endif //YARP_DEV_IDEVICEDRIVERPARAMETERS_H
An interface for the management of the parameters of a DeviceDriver.
virtual std::string getDeviceName() const =0
Get the name of the device (i.e.
virtual std::string getDeviceClassName() const =0
Get the name of the DeviceDriver class.
virtual bool getParamValue(const std::string &paramName, std::string &paramValue) const =0
Return the value (represented as a string) of the requested parameter.
virtual std::vector< std::string > getListOfParams() const =0
Return a list of all params used by the device.
virtual bool parseParams(const yarp::os::Searchable &config)=0
Parse the DeviceDriver parameters.
virtual std::string getDocumentationOfDeviceParams() const =0
Get the documentation of the DeviceDriver's parameters.
virtual std::string getConfiguration() const =0
Return the configuration of the device.
A base class for nested structures that can be searched.
Definition Searchable.h:31
For streams capable of holding different kinds of content, check what they actually have.
The main, catch-all namespace for YARP.
Definition dirs.h:16
#define YARP_dev_API
Definition api.h:18