mitkForm.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkForm_h
#define mitkForm_h
 
#include <mitkFileSystem.h>
#include <MitkFormsExports.h>
 
#include <memory>
#include <string>
#include <map>
#include <vector>
 
#include <nlohmann/json_fwd.hpp>
 
namespace mitk::Forms
{
  class Question;
 
  class MITKFORMS_EXPORT Form
  {
  public:
    class MITKFORMS_EXPORT Section
    {
    public:
      explicit Section(const std::string& title = "", const std::string& description = "");
 
      ~Section();
 
      Section(Section&& other) noexcept;
 
      Section& operator=(Section&& other) noexcept;
 
      std::string GetTitle() const;
 
      void SetTitle(const std::string& title);
 
      std::string GetDescription() const;
 
      void SetDescription(const std::string& description);
 
      std::vector<Question*> GetQuestions() const;
 
      void AddQuestion(Question* question);
 
    private:
      std::string m_Title;
      std::string m_Description;
      std::vector<std::unique_ptr<Question>> m_Questions;
    };
 
    explicit Form(const std::string& title = "", const std::string& description = "");
 
    ~Form();
 
    Form(Form&& other) noexcept;
 
    Form& operator=(Form&& other) noexcept;
 
    Section& AddSection(const std::string& title = "", const std::string& description = "");
 
    int GetNumberOfSections() const;
 
    Section& GetSection(int index);
 
    const Section& GetSection(int index) const;
 
    std::string GetTitle() const;
 
    void SetTitle(const std::string& title);
 
    std::string GetDescription() const;
 
    void SetDescription(const std::string& description);
 
    std::vector<Question*> GetQuestions() const;
 
    void AddQuestion(Question* question);
 
    void AddSupplement(const std::string& key);
 
    bool SetSupplement(const std::string& key, const std::string& value);
 
    const std::map<std::string, std::string>& GetSupplements() const;
 
    std::vector<Section>::const_iterator begin() const;
 
    std::vector<Section>::const_iterator end() const;
 
    std::vector<Section>::iterator begin();
 
    std::vector<Section>::iterator end();
 
  private:
    std::vector<Section> m_Sections;
    std::map<std::string, std::string> m_Supplements;
  };
 
  MITKFORMS_EXPORT void SubmitToCSV(const Form& form, const fs::path& csvPath);
 
  MITKFORMS_EXPORT void from_json(const nlohmann::ordered_json& j, Form& f);
 
  MITKFORMS_EXPORT void to_json(nlohmann::ordered_json& j, const Form& f);
}
 
#endif