IRobotDescription.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_DEV_IROBOTDESCRIPTION_H
#define YARP_DEV_IROBOTDESCRIPTION_H
 
#include <yarp/dev/api.h>
#include <yarp/os/Vocab.h>
#include <vector>
#include <string>
 
namespace yarp {
namespace dev {
 
struct DeviceDescription
{
    std::string  device_name;
    std::string  device_type;
    bool operator ==(DeviceDescription const& b) const
    {
        return this->device_name == b.device_name && this->device_type == b.device_type;
    }
};
 
class YARP_dev_API IRobotDescription
{
public:
    virtual ~IRobotDescription();
 
    virtual bool getAllDevices(std::vector<DeviceDescription>& dev_list) = 0;
 
    virtual bool getAllDevicesByType(const std::string &type, std::vector<DeviceDescription>& dev_list) = 0;
 
    virtual bool registerDevice(const DeviceDescription& dev) = 0;
 
    virtual bool unregisterDevice(const std::string& device_name) = 0;
};
 
} // namespace dev
} // namespace yarp
 
constexpr yarp::conf::vocab32_t VOCAB_IROBOT_DESCRIPTION            = yarp::os::createVocab32('i','r','o','b');
constexpr yarp::conf::vocab32_t VOCAB_IROBOT_GET                    = yarp::os::createVocab32('g','e','t');
constexpr yarp::conf::vocab32_t VOCAB_IROBOT_SET                    = yarp::os::createVocab32('s','e','t');
constexpr yarp::conf::vocab32_t VOCAB_IROBOT_DELETE                 = yarp::os::createVocab32('d','e','l');
constexpr yarp::conf::vocab32_t VOCAB_IROBOT_ALL                    = yarp::os::createVocab32('a','l','l');
constexpr yarp::conf::vocab32_t VOCAB_IROBOT_DEVICE                 = yarp::os::createVocab32('d','e','v');
constexpr yarp::conf::vocab32_t VOCAB_IROBOT_BY_TYPE                = yarp::os::createVocab32('t','y','p','e');
 
#endif // YARP_DEV_IROBOTDESCRIPTION_H