YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
IRobotDescription.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
3 * SPDX-License-Identifier: BSD-3-Clause
4 */
5
6#ifndef YARP_DEV_IROBOTDESCRIPTION_H
7#define YARP_DEV_IROBOTDESCRIPTION_H
8
9#include <yarp/dev/api.h>
12
13#include <vector>
14#include <string>
15
16namespace yarp::dev {
17
19{
20 public:
21 bool operator ==(DeviceDescription const& b) const
22 {
23 return this->device_name == b.device_name && this->device_type == b.device_type;
24 }
25};
26
34{
35public:
40
44 virtual yarp::dev::ReturnValue getAllDevices(std::vector<DeviceDescription>& dev_list) = 0;
45
49 virtual yarp::dev::ReturnValue getAllDevicesByType(const std::string &type, std::vector<DeviceDescription>& dev_list) = 0;
50
55
59 virtual yarp::dev::ReturnValue unregisterDevice(const std::string& device_name) = 0;
60
65};
66
67} // namespace yarp::dev
68
69#endif // YARP_DEV_IROBOTDESCRIPTION_H
bool operator==(const struct v4l2_control &left, const struct v4l2_control &right)
Definition CApiMock.h:65
std::string device_type
type of the device
std::string device_name
name of the device
This interface allows users to retrieve a list which contains the names and the types of the currentl...
virtual yarp::dev::ReturnValue registerDevice(const DeviceDescription &dev)=0
Register a new running yarp device into a robot description server.
virtual ~IRobotDescription()
Destructor.
virtual yarp::dev::ReturnValue getAllDevices(std::vector< DeviceDescription > &dev_list)=0
Ask the complete list of all yarp device drivers registered by a robot description server.
virtual yarp::dev::ReturnValue unregisterDevice(const std::string &device_name)=0
Unregister a running yarp device from a robot description server.
virtual yarp::dev::ReturnValue unregisterAll()=0
Unregister all the devices.
virtual yarp::dev::ReturnValue getAllDevicesByType(const std::string &type, std::vector< DeviceDescription > &dev_list)=0
Ask a list of all registered yarp device drivers whose type corresponds to the given param.
For streams capable of holding different kinds of content, check what they actually have.
#define YARP_dev_API
Definition api.h:18