IRemoteVariables.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_IREMOTEVARIABLES_H
#define YARP_DEV_IREMOTEVARIABLES_H
 
#include <string>
 
#include <yarp/os/Bottle.h>
#include <yarp/os/Vocab.h>
#include <yarp/dev/api.h>
 
namespace yarp::dev {
class IRemoteVariablesRaw;
class IRemoteVariables;
}
 
class YARP_dev_API yarp::dev::IRemoteVariablesRaw
{
public:
    virtual ~IRemoteVariablesRaw() {}
 
    virtual bool getRemoteVariableRaw(std::string key, yarp::os::Bottle& val) = 0;
 
    virtual bool setRemoteVariableRaw(std::string key, const yarp::os::Bottle& val) = 0;
 
    virtual bool getRemoteVariablesListRaw(yarp::os::Bottle* listOfKeys) = 0;
};
 
class YARP_dev_API yarp::dev::IRemoteVariables
{
public:
    virtual ~IRemoteVariables() {}
 
    virtual bool getRemoteVariable(std::string key, yarp::os::Bottle& val) = 0;
 
    virtual bool setRemoteVariable(std::string key, const yarp::os::Bottle& val) = 0;
 
    virtual bool getRemoteVariablesList(yarp::os::Bottle* listOfKeys) = 0;
};
 
constexpr yarp::conf::vocab32_t VOCAB_REMOTE_VARIABILE_INTERFACE   = yarp::os::createVocab32('i','v','a','r');
constexpr yarp::conf::vocab32_t VOCAB_VARIABLE                     = yarp::os::createVocab32('m','v','a','r');
constexpr yarp::conf::vocab32_t VOCAB_LIST_VARIABLES               = yarp::os::createVocab32('l','v','a','r');
 
 
#endif // YARP_DEV_IREMOTEVARIABLES_H