/home/breidi/Dropbox/signalserver/include/config/xml_parser.h

Go to the documentation of this file.

/*
    This file is part of the TOBI SignalServer.

    Commercial Usage
    Licensees holding valid Graz University of Technology Commercial
    licenses may use this file in accordance with the Graz University
    of Technology Commercial License Agreement provided with the
    Software or, alternatively, in accordance with the terms contained in
    a written agreement between you and Graz University of Technology.

    --------------------------------------------------

    GNU General Public License Usage
    Alternatively, this file may be used under the terms of the GNU
    General Public License version 3.0 as published by the Free Software
    Foundation and appearing in the file gpl.txt included in the
    packaging of this file.  Please review the following information to
    ensure the GNU General Public License version 3.0 requirements will be
    met: http://www.gnu.org/copyleft/gpl.html.

    In case of GNU General Public License Usage ,the TOBI SignalServer
    is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with the TOBI SignalServer. If not, see <http://www.gnu.org/licenses/>.

    Copyright 2010 Graz University of Technology
    Contact: SignalServer@tobi-project.org
*/

#ifndef XMLPARSER_H
#define XMLPARSER_H

// ticpp
#include "ticpp/ticpp.h"

// stl
#include <iostream>
#include <vector>
#include <string>
#include <map>

// boost
#include <boost/lexical_cast.hpp>

#include "tia/constants.h"

namespace tobiss
{

//---------------------------------------------------------------------------------------

class XMLParser
{
  public:
    XMLParser()
    {
      #ifdef DEBUG
      std::cout << " XMLParser: Default Constructor" << std::endl;
      #endif
    }
    XMLParser(const std::string xml_file);
    virtual ~XMLParser()
    {
      #ifdef DEBUG
        std::cout << "XMLParser: Destructor" << std::endl;
      #endif
    }

    const ticpp::Iterator<ticpp::Element> getSubjectElement() const {  return(subject_);  }

    const ticpp::Iterator<ticpp::Element> getServerSettingsElement() const { return(server_settings_); }

    const ticpp::Iterator<ticpp::Element> getHardwareElement(const unsigned int n) const
      {  return(hardware_.at(n).second);  }

    const ticpp::Iterator<ticpp::Element> getHardwareElement(const std::string& s) const
      {
        for(unsigned int n = 0; n < hardware_.size(); n++)
          if(s == hardware_.at(n).first)
            return(hardware_[n].second);

        return(0);
        //     throw(ticpp::Exception("XMLParser::getHardwareElement -- Element "+s+" not found!"));
        // * @throws ticpp::exception if hardware element not found.
      }

    const std::string getHardwareElementName(const unsigned int n) const {  return(hardware_.at(n).first);  }

//    /**
//    * @brief Get the mode of the n-th  <hardware> node.
//    * @param[in] n  Number of the respective hardware block in the xml config file.
//    * @return string  Type (master or slave) of the respective <hardware>
//    */
//    const std::string getHardwareElementType(const unsigned int n) const
//    {
//      return(hardware_.at(n).second->FirstChildElement(cst_.hw_mode ,false)->GetText());
//    }

    unsigned int getNrOfHardwareElements() const  {  return(hardware_.size());  }

    std::map<std::string,std::string> parseSubject();

    std::map<std::string,std::string> parseServerSettings();

//    /**
//    * @brief Parse the <measurement_channels> section in the config file -- used for common channel settings.
//    * @param[in] elem   The ticpp-element to parse.
//    * @param[out] nr_ch The number of channels defined in the ticpp-element.
//    * @param[out] naming The channel-naming defined in the ticpp-element.
//    * @param[out] type The channel-types defined in the ticpp-element.
//    * @throw ticpp::Exception
//    */
//    void parseDeviceChannels(ticpp::Iterator<ticpp::Element>const &elem, boost::uint16_t& nr_ch,
//                             std::string& naming, std::string& type);
//
//    /**
//    * @brief Parse the <selection> section in the config file -- used for individual channel settings.
//    * @param[in] elem   The ticpp-element to parse.
//    * @param[out] ch The channel number defined in the ticpp-element.
//    * @param[out] name The channel's name defined in the ticpp-element.
//    * @param[out] type The channel's type defined in the ticpp-element.
//    * @throw ticpp::Exception
//    */
//    void parseChannelSelection(ticpp::Iterator<ticpp::Element>const &elem, boost::uint16_t& ch,
//                               std::string& name, std::string& type);
//
//    /**
//    * @brief Check if all mandatory tags in <hardware> are given.
//    * @throw ticpp::Exception
//    */
//    void checkMandatoryHardwareTags(ticpp::Iterator<ticpp::Element> hw);

//    void parseFileReader();

    bool usesDataFile()
    { return(external_data_file_); }

//    /**
//    * @brief TODO
//    */
//    const std::map<std::string, std::string> getFileReaderMap()
//    { return(file_reader_map_); }


//-----------------------------------------------

  private:
    void checkHardwareAttributes(std::map<std::string,std::string>& m);
    bool isNumber(const std::string& s)
    {
      for (unsigned int i = 0; i < s.length(); i++)
        if (!isdigit(s[i]))
          return false;

      return true;
    }

    bool equalsYesOrNo(const std::string& s);

    void parseFileLocation(ticpp::Iterator<ticpp::Element> elem, std::map<std::string, std::string>& m);

//-----------------------------------------------
  private:
    ticpp::Document doc_;    
    ticpp::Iterator<ticpp::Element> subject_;    
    ticpp::Iterator<ticpp::Element> server_settings_;  

    ticpp::Iterator<ticpp::Element> file_reader_;  
    bool external_data_file_;

    std::map<std::string, std::string> subject_map_;
    std::map<std::string, std::string> server_settings_map_;
//    std::map<std::string, std::string> file_reader_map_;

    std::vector< std::pair<std::string, ticpp::Iterator<ticpp::Element> > > hardware_;

    tia::Constants cst_;  
};

} // Namespace tobiss

//---------------------------------------------------------------------------------------
#endif // XMLPARSER_H