MultipleFileProperty.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidAPI/DllConfig.h"
#include "MantidKernel/MultiFileNameParser.h"
#include "MantidKernel/PropertyWithValue.h"
#include <set>
#include <vector>
 
namespace Mantid {
namespace API {
 
class MANTID_API_DLL MultipleFileProperty : public Kernel::PropertyWithValue<std::vector<std::vector<std::string>>> {
public:
  MultipleFileProperty(const std::string &name, unsigned int action,
                       const std::vector<std::string> &exts = std::vector<std::string>(),
                       bool allowEmptyTokens = false);
 
  MultipleFileProperty(const std::string &name, const std::vector<std::string> &exts = std::vector<std::string>());
 
  MultipleFileProperty(const MultipleFileProperty &) = default;
  MultipleFileProperty &operator=(const MultipleFileProperty &) = default;
 
  MultipleFileProperty *clone() const override { return new MultipleFileProperty(*this); }
 
  std::string setValue(const std::string &propValue) override;
  std::string value() const override;
  std::string getDefault() const override;
  bool isOptional() const;
 
  const std::vector<std::string> &getExts() const { return m_exts; }
 
  const std::string &getDefaultExt() const { return m_defaultExt; }
 
  // Unhide the PropertyWithValue assignment operator
  using Kernel::PropertyWithValue<std::vector<std::vector<std::string>>>::operator=;
 
private:
  std::string isEmptyValueValid() const;
  std::string setValueAsSingleFile(const std::string &propValue);
  std::string setValueAsMultipleFiles(const std::string &propValue);
  bool m_multiFileLoadingEnabled;
 
  std::vector<std::string> m_exts;
  Kernel::MultiFileNameParsing::Parser m_parser;
  std::string m_defaultExt;
  unsigned int m_action{2};
  std::string m_oldPropValue;
  std::vector<std::vector<std::string>> m_oldFoundValue;
  bool m_allowEmptyTokens{false};
};
 
} // namespace API
} // namespace Mantid