XMLReader.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_ROBOTINTERFACE_XMLREADER_H
#define YARP_ROBOTINTERFACE_XMLREADER_H
 
#include <yarp/robotinterface/api.h>
#include <yarp/robotinterface/Robot.h>
 
#include <yarp/os/Searchable.h>
#include <yarp/os/Property.h>
 
#include <string>
 
 
namespace yarp::robotinterface {
 
class YARP_robotinterface_API XMLReaderResult
{
public:
    static XMLReaderResult ParsingFailed()
    {
        XMLReaderResult result;
        result.parsingIsSuccessful = false;
        return result;
    }
 
    bool parsingIsSuccessful = false;
 
    Robot robot;
};
 
class YARP_robotinterface_API XMLReader
{
public:
    XMLReader();
    virtual ~XMLReader();
 
    XMLReaderResult getRobotFromFile(const std::string& filename,
                                     const yarp::os::Searchable& config = yarp::os::Property());
 
    XMLReaderResult getRobotFromString(const std::string& filename,
                                       const yarp::os::Searchable& config = yarp::os::Property());
 
    void setVerbose(bool verbose);
    void setEnableDeprecated(bool enab);
 
private:
    class Private;
    Private* const mPriv;
 
}; // class XMLReader
 
} // namespace yarp::robotinterface
 
#endif // YARP_ROBOTINTERFACE_XMLREADER_H