src/Config/Config_FeatureReader.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 /*
   4  * Config_FeatureReader.h
   5  *
   6  *  Created on: Mar 20, 2014
   7  *      Author: sbh
   8  */
   9
  10 #ifndef CONFIG_FEATUREREADER_H_
  11 #define CONFIG_FEATUREREADER_H_
  12
  13 #include <Config_def.h>
  14 #include <Config_XMLReader.h>
  15 #include <memory>
  16
  17 #include <string>
  18 #include <list>
  19 #include <map>
  20
  21 class Config_FeatureMessage;
  22
  23 /*!
  24  * \class Config_FeatureReader
  25  * \ingroup Config
  26  * \brief Class to process feature's xml definition.
  27  */
  28 class Config_FeatureReader : public Config_XMLReader
  29 {
  30  public:
  31   /// Constructor
  32   Config_FeatureReader(const std::string& theXmlFile,
  33                        const std::string& theLibraryName,
  34                        const char* theEventGenerated = 0);
  35   virtual ~Config_FeatureReader();
  36   /// Returns list of all features defined in reader's file
  37   std::list<std::string> features() const;
  38
  39  protected:
  40   /// Overloaded method. Defines how to process each node
  41   virtual void processNode(xmlNodePtr aNode);
  42
  43   /// Overloaded method. Clears attribute cache on extit from attribute's node
  44   virtual void cleanup(xmlNodePtr aNode);
  45
  46   /// Overloaded method. Defines if the given node should be parsed recursively
  47   virtual bool processChildren(xmlNodePtr aNode);
  48
  49   /// Fills feature message
  50   void fillFeature(xmlNodePtr theRoot,
  51                    const std::shared_ptr<Config_FeatureMessage>& outFeatureMessage);
  52
  53   /// Stores an attribute in internal map for later use.
  54   /// Key is "Node_Name:Node_Attribute" and value is getProperty(theNodeAttribute)
  55   void storeAttribute(xmlNodePtr theNode, const char* theNodeAttribute);
  56   /// Restores an attribute from internal map.
  57   std::string restoreAttribute(xmlNodePtr theNode, const char* theNodeAttribute);
  58   /// Restores an attribute from internal map.
  59   std::string restoreAttribute(const char* theNodeName, const char* theNodeAttribute);
  60
  61   bool cleanupAttribute(xmlNodePtr theNode, const char* theNodeAttribute);
  62   bool cleanupAttribute(const char* theNodeName, const char* theNodeAttribute);
  63
  64  private:
  65   /// A map to store all parent's attributes.
  66   /// The key has from "Node_Name:Node_Attribute"
  67   std::map<std::string, std::string> myParentAttributes;
  68   std::string myLibraryName;
  69
  70   std::list<std::string> myFeatures;
  71   /// event generated on feature data sending, by default it is Config_FeatureMessage::GUI_EVENT()
  72   const char* myEventGenerated;
  73   bool myIsProcessWidgets;
  74 };
  75
  76 #endif /* CONFIG_FEATUREREADER_H_ */