IndexProperty.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2017 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 "MantidAPI/IWorkspaceProperty.h"
#include "MantidAPI/IndexTypeProperty.h"
#include "MantidIndexing/SpectrumIndexSet.h"
#include "MantidKernel/ArrayProperty.h"
 
namespace Mantid {
namespace Indexing {
class IndexInfo;
}
namespace API {
 
class MANTID_API_DLL IndexProperty : public Kernel::ArrayProperty<int64_t> {
public:
  IndexProperty(const std::string &name, const IWorkspaceProperty &workspaceProp,
                const IndexTypeProperty &indexTypeProp,
                const Kernel::IValidator_sptr &validator = Kernel::IValidator_sptr(new Kernel::NullValidator));
 
  IndexProperty(const IndexProperty &) = default;
  // Copy assignment is deleted since there are reference type members.
  IndexProperty &operator=(const IndexProperty &) = delete;
 
  IndexProperty *clone() const override;
 
  using Kernel::ArrayProperty<int64_t>::operator=;
  using Kernel::ArrayProperty<int64_t>::operator const std::vector<int64_t> &;
 
  bool isDefault() const override;
  std::string isValid() const override;
  IndexProperty &operator=(const std::string &rhs);
  operator Indexing::SpectrumIndexSet() const;
  Indexing::SpectrumIndexSet getIndices() const;
  Indexing::IndexInfo getFilteredIndexInfo() const;
 
  static std::string generatePropertyName(const std::string &name = "");
 
private:
  const Indexing::IndexInfo &getIndexInfoFromWorkspace() const;
 
  const IWorkspaceProperty &m_workspaceProp;
  const IndexTypeProperty &m_indexTypeProp;
  mutable Indexing::SpectrumIndexSet m_indices;
  mutable bool m_indicesExtracted;
  std::string m_validString;
};
 
} // namespace API
} // namespace Mantid