src/Config/Config_WidgetReader.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 /*
   4  * Config_WidgetReader.h
   5  *
   6  *  Created on: Apr 2, 2014
   7  *      Author: sbh
   8  */
   9
  10 #ifndef CONFIG_WIDGETREADER_H_
  11 #define CONFIG_WIDGETREADER_H_
  12
  13 #include <Config_def.h>
  14 #include <Config_XMLReader.h>
  15
  16 #include <map>
  17 #include <string>
  18
  19 /*!
  20  * \class Config_WidgetReader
  21  * \brief Class that dumps xml definitions of widgets for
  22  * further processing in the WidgetFactory
  23  */
  24 class Config_WidgetReader : public Config_XMLReader
  25 {
  26  public:
  27   CONFIG_EXPORT Config_WidgetReader(const std::string& theXmlFile);
  28   CONFIG_EXPORT virtual ~Config_WidgetReader();
  29
  30   /// Extract feature's widget configuration from local cache, stored on node processing
  31   CONFIG_EXPORT std::string featureWidgetCfg(const std::string& theFeatureName);
  32   /// Extract feature's description from local cache, stored on node processing
  33   CONFIG_EXPORT std::string featureDescription(const std::string& theFeatureName);
  34
  35  protected:
  36   /// Overloaded method. Defines how to process each node
  37   void processNode(xmlNodePtr theNode);
  38   /// Overloaded method. Defines if the given node should be parsed recursively
  39   bool processChildren(xmlNodePtr theNode);
  40   /// Extracts xml definition of the given node and it's children
  41   std::string dumpNode(xmlNodePtr theNode);
  42   /// Replace all "source" nodes with their content (used before dumping nodes)
  43   void resolveSourceNodes(xmlNodePtr theNode);
  44
  45  private:
  46   std::map<std::string, std::string> myWidgetCache;
  47   std::map<std::string, std::string> myDescriptionCache;
  48
  49 };
  50
  51 #endif /* CONFIG_WIDGETREADER_H_ */