C:/Jenkins/workspace/CPP_create_documentation/slaves/windows/lib_src/FileHandling/include/XmlFile.h

//--------------------------------------------------------
// Earth Observation Mission CFI Software. Version 4.18
//--------------------------------------------------------


#ifndef _XMLFILE_H
#define _XMLFILE_H


#include <string>
#include <vector>

#include "CfiClass.h"
#include "CfiError.h"
#include "FixedHeader.h"
#include "FileHandlingData.h"


namespace EECFI
{
   
   class XF_DECL XmlFile:public CfiClass
   {
      public:
      
         XmlFile(); 
         
         explicit XmlFile(const std::string &fileNam) ;
         
         ~XmlFile() EXCEPT;

         // Methods for creating, reading and writing

         void create() ;
         
         void read(const std::string &fileNam) ;
         
         void write() ;
         
         void write(const std::string &fileNam) ;
         
         void clean() ;

         // Methods for navigating the tree

         void root() ;
         
         void next() ;
         
         void nextSibling() ;
         
         void toElement(const std::string &element) ;
         
         void toPath(const std::string &path) ;
         
         std::string currentElementName() const;
         
         std::string currentPathName() const;

         // Methods for reading data

         std::string getElementValueAsString(const std::string &element) ;
         
         long getElementValueAsInt(const std::string &element) ;
         
         double getElementValueAsReal(const std::string &element) ;
         
         std::vector<std::string> & getElementArrayAsString(const std::string &element,
                                                            std::vector<std::string> &outVector) ;

         std::vector<long> & getElementArrayAsInt(const std::string &element,
                                                  std::vector<long> &outVector) ;

         std::vector<double> & getElementArrayAsReal(const std::string &element,
                                                     std::vector<double> &outVector) ;

         std::string getAttributeValueAsString(const std::string &element,
                                               const std::string &attribute) ;

         long getAttributeValueAsInt(const std::string &element,
                                     const std::string &attribute) ;

         double getAttributeValueAsReal(const std::string &element,
                                        const std::string &attribute) ;

         std::string getPathValueAsString(const std::string &path) ;
         
         long getPathValueAsInt(const std::string &path) ;
         
         double getPathValueAsReal(const std::string &path) ;
         
         std::vector<std::string> & getPathArrayAsString(const std::string &node,
                                                         std::vector<std::string> &outVector) ;

         std::vector<long> & getPathArrayAsInt(const std::string &node,
                                               std::vector<long> &outVector) ;

         std::vector<double> & getPathArrayAsReal(const std::string &node,
                                                  std::vector<double> &outVector) ;

         // Methods for adding and removing nodes

         void createRoot(const std::string &element) ;
         
         void addChild(const std::string &parent,
                       const std::string &child) ;

         void addNext(const std::string &current,
                      const std::string &next) ;

         void addPrevious(const std::string &current,
                          const std::string &previous) ;

         void addAttribute(const std::string &element,
                           const std::string &attribute) ;
                        
         void copyNode(const std::string &destPath,
                       const std::string &sourceXmlFile,
                       const std::string &sourcePath) ;

         void removeNode(const std::string &path) ;

         // Methods for setting values

         void setValue(const std::string &path,
                       const std::string &value,
                       const std::string &format) ;

         void setValue(const std::string &path,
                       const long value,
                       const std::string &format) ;

         void setValue(const std::string &path,
                       const double value,
                       const std::string &format) ;

         // Methods for adding nodes with values

         void addChild(const std::string &parent,
                       const std::string &child,
                       const std::string &value,
                       const std::string &format) ;

         void addChild(const std::string &parent,
                       const std::string &hild,
                       const long value,
                       const std::string &format) ;

         void addChild(const std::string &parent,
                       const std::string &child,
                       const double value,
                       const std::string &format) ;

         void addNext(const std::string &current,
                      const std::string &next,
                      const std::string &value,
                      const std::string &format) ;

         void addNext(const std::string &current,
                      const std::string &next,
                      const long value,
                      const std::string &format) ;

         void addNext(const std::string &current,
                      const std::string &next,
                      const double value,
                      const std::string &format) ;

         void addPrevious(const std::string &current,
                          const std::string &previous,
                          const std::string &value,
                          const std::string &format) ;

         void addPrevious(const std::string &current,
                          const std::string &previous,
                          const long value,
                          const std::string &format) ;

         void addPrevious(const std::string &current,
                          const std::string &previous,
                          const double value,
                          const std::string &format) ;

         void addAttribute(const std::string &element,
                           const std::string &attribute,
                           const std::string &value,
                           const std::string &format) ;

         void addAttribute(const std::string &element,
                           const std::string &attribute,
                           const long value,
                           const std::string &format) ;

         void addAttribute(const std::string &element,
                           const std::string &attribute,
                           const double value,
                           const std::string &format) ;

         // Methods for searching elements by value

         std::string findValueInElement(const std::string &element,
                                        const std::string &value) ;

         std::string findValueInPath(const std::string &path,
                                     const std::string &value) ;
      
         // Methods for handling the file header
      
         void createHeader(long fileExtensionType) ;

         void createHeader(FixedHeader &xmlHeader) ;
         
         std::string createFileName(long satelliteId,
                                    const std::string &fileClass,
                                    const std::string &fileType,
                                    const std::string &instanceId,
                                    long fileExtensionType) const;

         FileNameItems getFileNameItems(std::string &fileNam) const;

         void setFixedHeaderItem(const std::string &itemName,
                                 const std::string &itemValue) ;

         void setFixedHeaderItems(const std::string &fileNam,
                                  const std::string &fileDescription,
                                  const std::string &notes,
                                  const std::string &mission,
                                  const std::string &fileClass,
                                  const std::string &filetype,
                                  const std::string &validityStart, 
                                  const std::string &validityStop,
                                  const long   fileVersion,
                                  const std::string &system,
                                  const std::string &creator,
                                  const std::string &creatorVersion,
                                  const std::string &creationDate) ;

         std::string getFixedHeaderItem(const std::string &itemName) ;
         
         FixedHeader getFixedHeader() ;
         
         long getId() const;
         
         std::string getFileName() const;
         
         void setSchema( const std::string &schemaName, bool setAll);
         
         void removeSchema( bool removeAll);
         
         std::vector<std::string>& getStringValuesFromList(const std::string &listPath, 
                                                           const std::string &element, 
                                                           std::vector <std::string> &outVector) ;      

      protected:

      private:
         long id;              
         std::string fileName; 


  };//class XmlFile
}//namespace EECFI

#endif