xml_io.h

Go to the documentation of this file.

 
//   File description
 
#ifndef xml_io_h
#define xml_io_h
 
#include "arts.h"
#include "xml_io_base.h"
#include "xml_io_arts_types.h"
 
//   XML parser classes
 
 
class ArtsXMLTag : public XMLTag {
 public:
  ArtsXMLTag(const Verbosity& rverbosity) : XMLTag(rverbosity){};
 
  using XMLTag::add_attribute;
  
  void add_attribute(const String& aname, const std::vector<QuantumNumberType>& value);
  
  void add_attribute(const String& aname, const ArrayOfSpecies& value, const bool self, const bool bath);
 
  using XMLTag::get_attribute_value;
 
  void get_attribute_value(const String& aname, SpeciesTag& value);
  
  void get_attribute_value(const String& aname, ArrayOfSpecies& value, bool& self, bool& bath);
  
  void get_attribute_value(const String& aname, std::vector<QuantumNumberType>& value);
};
 
//   General XML handling routines
 
void xml_parse_from_stream(
    istream &, Vector &, bifstream *, ArtsXMLTag &, const Verbosity &verbosity);
 
void xml_parse_from_stream(
    istream &, ArrayOfString &, bifstream *, ArtsXMLTag &, const Verbosity &);
 
//   Generic IO routines for XML files
 
void xml_find_and_open_input_file(std::shared_ptr<istream>& ifs,
                                  const String& filename,
                                  const Verbosity& verbosity);
 
//   Default file names
 
void filename_xml(String& filename, const String& varname);
 
void filename_xml_with_index(String& filename,
                             const Index& file_index,
                             const String& varname,
                             const Index& digits = 0);
 
//   Generic IO routines for XML files
 
 
template <typename T>
void xml_read_from_file(const String& filename,
                        T& type,
                        const Verbosity& verbosity) {
  CREATE_OUT2;
 
  String xml_file = filename;
  find_xml_file(xml_file, verbosity);
  xml_read_from_file_base(xml_file, type, verbosity);
}
 
 
template <typename T>
void xml_write_to_file(const String& filename,
                       const T& type,
                       const FileType ftype,
                       const Index no_clobber,
                       const Verbosity& verbosity) {
  CREATE_OUT2;
 
  String efilename{add_basedir(filename)};
 
  std::unique_ptr<ostream> ofs;
 
  if (no_clobber) efilename = make_filename_unique(efilename, ".xml");
 
  xml_write_to_file_base(efilename, type, ftype, verbosity);
}
 
#endif