paramFile.h

Go to the documentation of this file.

// vi: set ts=2:
//

#ifndef BALL_FORMAT_PARAMFILE_H
#define BALL_FORMAT_PARAMFILE_H

#ifndef BALL_SYSTEM_FILE_H
# include <BALL/SYSTEM/file.h>
#endif

#ifndef BALL_DATATYPE_STRING_H
# include <BALL/DATATYPE/string.h>
#endif

#include <QtXml/QXmlStreamReader>
#include <QtXml/QXmlStreamWriter>
#include <QtCore/QFile>

#include <map>
#include <list>


namespace BALL
{
  enum BALL_EXPORT ParameterType
  {
    INFILE,
    OUTFILE,
    STRING,
    INT,
    DOUBLE,
    INFILELIST,
    OUTFILELIST,
    STRINGLIST,
    INTLIST,
    DOUBLELIST,
    GALAXY_OPT_OUTDIR,
    GALAXY_OPT_OUTID
  };

  struct BALL_EXPORT ParameterDescription
  {
    // constructor
    ParameterDescription()
    {
      name = "";
      description = "";
      category = "";
      mandatory = false;
      advanced = false;
      type = INFILE;
      output_format_source = "";
      allowed_values.clear();
      supported_formats.clear();
      hidden = false;
    };

    String name;
    String description;
    String category;
    bool mandatory;
    bool advanced;
    ParameterType type;

    String output_format_source;

    list<String> allowed_values;

    list<String> supported_formats;

    // if parameters shall be hidden in galaxy
    bool hidden;
  };

  class BALL_EXPORT ParamFile : public File
  {
    public:

      ParamFile(const String& name, File::OpenMode open_mode);
      ~ParamFile();

      void writeSection(String section_name, String section_description, String version, const String& section_helptext,
                        const String& category, const std::list<std::pair<String,ParameterDescription> >& descriptions,
                        const std::map<String,list<String> >& values);

      void readSection(String& section_name, String& section_description, String& version, String& section_helptext,
                       String& category, std::list<std::pair<String, ParameterDescription> >& descriptions,
                       std::map<String,list<String> >& values,
                       bool overwrite_existing=false);

      void close();


    protected:

      String filename_;
      File::OpenMode open_mode_;
      bool mode_read_;
      QXmlStreamReader* xmlIn_;
      QXmlStreamWriter* xmlOut_;
      QFile* file_;
  };
}

#endif