cl_XML.hpp

Go to the documentation of this file.

/*
 * BELFEM -- The Berkeley Lab Finite Element Framework
 * Copyright (c) 2026, The Regents of the University of California,
 * through Lawrence Berkeley National Laboratory (subject to receipt of any required
 * approvals from the U.S. Dept. of Energy).  All rights reserved.
 *
 * Developers: Christian Messe, Gregory Giard
 *
 * See the top-level LICENSE file for the complete license and disclaimer.
 */
 
#ifndef BELFEM_CL_XML_HPP
#define BELFEM_CL_XML_HPP
 
#ifdef BELFEM_XML
#include <tinyxml2.h>
#endif
 
#include "typedefs.hpp"
#include "filetools.hpp"
 
namespace belfem
{
//------------------------------------------------------------------------------
    class XML
    {
        const string          mPath;
#ifdef BELFEM_XML
        tinyxml2::XMLDocument mFile;
 
        tinyxml2::XMLElement* mActiveElement = nullptr;
 
        // current level in XML file
        uint mLevel = 0;
#endif
 
//------------------------------------------------------------------------------
    public:
//------------------------------------------------------------------------------
 
        XML( const string & aPath,
             const FileMode aMode = FileMode::OPEN_RDONLY );
 
//------------------------------------------------------------------------------
 
        ~XML();
 
//------------------------------------------------------------------------------

         inline const string &
         path() const
         {
            return mPath ;
         }
 
//------------------------------------------------------------------------------

         bool
         child_exists( const string & aLabel );
 
//------------------------------------------------------------------------------

        uint
        number_of_children();
 
//------------------------------------------------------------------------------

        uint
        number_of_children( const string & aLabel );
 
//------------------------------------------------------------------------------

         bool
         next_sibling_of_same_name();
 
//------------------------------------------------------------------------------
 
        void
        select_first_child( const string & aLabel );
 
//------------------------------------------------------------------------------
 
        void
        select_parent();
 
//------------------------------------------------------------------------------

        void
        select_subtree( const string & aTree );
 
//------------------------------------------------------------------------------
 
        string
        get_string( const string & aKey );
 
//------------------------------------------------------------------------------
 
        int
        get_int( const string & aKey );
 
//------------------------------------------------------------------------------
 
        real
        get_real( const string & aKey );
 
//------------------------------------------------------------------------------
 
        bool
        get_bool( const string & aKey );
 
//------------------------------------------------------------------------------
 
        bool
        key_exists( const string & aKey );
 
//------------------------------------------------------------------------------
    };
//------------------------------------------------------------------------------
}
#endif //BELFEM_CL_XML_HPP