cmnXMLPath.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*

  Author(s):  Ankur Kapoor, Anton Deguet, Ali Uneri
  Created on: 2004-04-30

  (C) Copyright 2004-2012 Johns Hopkins University (JHU), All Rights
  Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---

*/


#pragma once

#ifndef _cmnXMLPath_h
#define _cmnXMLPath_h

#include <cisstCommon/cmnConfigXML.h>
#include <cisstCommon/cmnGenericObject.h>

#if CISST_HAS_XML

// always include last
#include <cisstCommon/cmnExportXML.h>

// forward declaration of struct containing all data used by wrapper.
class cmnXMLPathData;

class CISST_EXPORT cmnXMLPath: public cmnGenericObject
{
    CMN_DECLARE_SERVICES(CMN_NO_DYNAMIC_CREATION, CMN_LOG_ALLOW_DEFAULT);

protected:
    cmnXMLPathData * Data;

public:
    cmnXMLPath();

    virtual ~cmnXMLPath();

    void SetInputSource(const char * filename);
    void SetInputSource(const std::string & fileName);

    bool ValidateWithSchema(const char * filename);
    bool ValidateWithSchema(const std::string & fileName);

    const std::string & GetLastErrors(void) const;

    bool SaveAs(const char * filename) const;
    bool SaveAs(const std::string & fileName) const;

    void PrintValue(std::ostream & out, const char * context, const char * XPath);

    bool GetXMLValue(const char * context, const char * XPath, bool & value);
    bool GetXMLValue(const char * context, const char * XPath, bool & value, const bool & valueIfMissing);
    bool SetXMLValue(const char * context, const char * XPath, const bool & value);
    bool Query(const char * query, bool & value);

    bool GetXMLValue(const char * context, const char * XPath, int & value);
    bool GetXMLValue(const char * context, const char * XPath, int & value, const int & valueIfMissing);
    bool SetXMLValue(const char * context, const char * XPath, const int & value);
    bool Query(const char * query, int & value);

    bool GetXMLValue(const char * context, const char * XPath, double & value);
    bool GetXMLValue(const char * context, const char * XPath, double & value, const double & valueIfMissing);
    bool SetXMLValue(const char * context, const char * XPath, const double & value);
    bool Query(const char * query, double & value);

    bool GetXMLValue(const char * context, const char * XPath, std::string & value);
    bool GetXMLValue(const char * context, const char * XPath, std::string & value, const std::string & valueIfMissing);
    bool SetXMLValue(const char * context, const char * XPath, const std::string & value);
    bool Query(const char * query, std::string & value);

    template <class __elementType>
    bool GetXMLValue(const std::string & context, const std::string & XPath, __elementType & value) {
        return this->GetXMLValue(context.c_str(), XPath.c_str(), value);
    }

    template <class __elementType>
    bool GetXMLValue(const std::string & context, const std::string & XPath, __elementType & value, const __elementType & valueIfMissing) {
        return this->GetXMLValue(context.c_str(), XPath.c_str(), value, valueIfMissing);
    }

    template <class __elementType>
    bool SetXMLValue(const std::string & context, const std::string & XPath, const __elementType & value)
    {
        return this->SetXMLValue(context.c_str(), XPath.c_str(), value);
    }

    template <class __elementType>
    bool Query(const std::string & query, __elementType & value) {
        return this->Query(query.c_str(), value);
    }
};


CMN_DECLARE_SERVICES_INSTANTIATION(cmnXMLPath);

#endif // CISST_HAS_XML

#endif // _cmnXMLPath_h