PropertySourceXml.h

Go to the documentation of this file.

/*******************************************************************************
 Copyright (c) 2020, Fabio Muratore, Honda Research Institute Europe GmbH, and
 Technical University of Darmstadt.
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 3. Neither the name of Fabio Muratore, Honda Research Institute Europe GmbH,
    or Technical University of Darmstadt, nor the names of its contributors may
    be used to endorse or promote products derived from this software without
    specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL FABIO MURATORE, HONDA RESEARCH INSTITUTE EUROPE GMBH,
 OR TECHNICAL UNIVERSITY OF DARMSTADT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#ifndef _PROPERTYSOURCEXML_H_
#define _PROPERTYSOURCEXML_H_

#include "PropertySource.h"

#include <libxml/tree.h>

#include <map>

namespace Rcs
{

/**
 * Property source backed by the attributes of an xml node.
 */
class PropertySourceXml : public PropertySource
{
private:
    xmlNodePtr node;
    xmlDocPtr doc;
    
    std::map<std::string, PropertySource*> children;
    std::map<std::string, std::vector<PropertySource*>> listChildren;
public:
    /**
     * Constructor
     *
     * @param[in] node node whose attributes will be read
     * @param[in] doc  document to destroy on close. Use to make the node owned by this class. If null, node will not be destroyed.
     */
    PropertySourceXml(xmlNodePtr node, xmlDocPtr doc = NULL);
    
    /**
     * Constructor, loading XML from filename.
     * Expects a root tag named 'Experiment'.
     * @param configFile xml file name
     */
    explicit PropertySourceXml(const char* configFile);
    
    virtual ~PropertySourceXml();
    
    virtual bool exists();
    
    virtual bool getProperty(std::string& out, const char* property);

    bool getProperty(std::vector<std::string> &out, const char *property) override;

    virtual bool getProperty(double& out, const char* property);
    
    virtual bool getProperty(int& out, const char* property);
    
    virtual bool getProperty(MatNd*& out, const char* property);
    
    virtual bool getPropertyBool(const char* property, bool def = false);
    
    virtual PropertySource* getChild(const char* prefix);
    
    virtual const std::vector<PropertySource*>& getChildList(const char* prefix);
    
    virtual PropertySource* clone() const;
    
    virtual void saveXML(const char* fileName, const char* rootNodeName);
};

} /* namespace Rcs */

#endif /* _PROPERTYSOURCEXML_H_ */