AnalysisDataService.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/DllConfig.h"
#include "MantidAPI/Workspace.h"
#include "MantidKernel/DataService.h"
#include "MantidKernel/SingletonHolder.h"
 
#include <Poco/AutoPtr.h>
 
namespace Mantid {
 
namespace API {
 
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
 
class WorkspaceGroup;
 
class MANTID_API_DLL AnalysisDataServiceImpl final : public Kernel::DataService<API::Workspace> {
public:
  class GroupWorkspacesNotification : public DataServiceNotification {
  public:
    GroupWorkspacesNotification(const std::vector<std::string> &wsnames)
        : DataServiceNotification("", std::shared_ptr<API::Workspace>()), m_wsnames(wsnames) {}
    const std::vector<std::string> &inputworkspacenames() const { return m_wsnames; }
 
  private:
    std::vector<std::string> m_wsnames; 
  };
 
  class UnGroupingWorkspaceNotification : public DataServiceNotification {
  public:
    UnGroupingWorkspaceNotification(const std::string &name, const std::shared_ptr<Workspace> &obj)
        : DataServiceNotification(name, obj) {}
  };
 
  class GroupUpdatedNotification : public DataServiceNotification {
  public:
    GroupUpdatedNotification(const std::string &name);
    std::shared_ptr<const WorkspaceGroup> getWorkspaceGroup() const;
  };
 
 
public:
  const std::string &illegalCharacters() const;
  void setIllegalCharacterList(const std::string &);
  const std::string isValid(const std::string &name) const;
  void add(const std::string &name, const std::shared_ptr<API::Workspace> &workspace) override;
  void addOrReplace(const std::string &name, const std::shared_ptr<API::Workspace> &workspace) override;
  virtual void rename(const std::string &oldName, const std::string &newName);
  virtual Workspace_sptr remove(const std::string &name);
  const std::string uniqueName(const int n = 5, const std::string &prefix = "", const std::string &suffix = "");
  const std::string uniqueHiddenName();
 
  template <typename WSTYPE> std::shared_ptr<WSTYPE> retrieveWS(const std::string &name) const {
    // Get as a bare workspace
    try {
      // Cast to the desired type and return that.
      return std::dynamic_pointer_cast<WSTYPE>(Kernel::DataService<API::Workspace>::retrieve(name));
 
    } catch (Kernel::Exception::NotFoundError &) {
      throw;
    }
  }
 
  std::vector<Workspace_sptr> retrieveWorkspaces(const std::vector<std::string> &names,
                                                 bool unrollGroups = false) const;
 
  void sortGroupByName(const std::string &groupName);
  void addToGroup(const std::string &groupName, const std::string &wsName);
  void deepRemoveGroup(const std::string &name);
  void removeFromGroup(const std::string &groupName, const std::string &wsName);
 
  std::map<std::string, Workspace_sptr> topLevelItems() const;
 
private:
  void verifyName(const std::string &name, const std::shared_ptr<API::WorkspaceGroup> &workspace);
  static char getRandomLowercaseLetter();
 
  friend struct Mantid::Kernel::CreateUsingNew<AnalysisDataServiceImpl>;
  AnalysisDataServiceImpl();
  AnalysisDataServiceImpl(const AnalysisDataServiceImpl &) = delete;
  AnalysisDataServiceImpl &operator=(const AnalysisDataServiceImpl &) = delete;
  ~AnalysisDataServiceImpl() override = default;
 
  std::string m_illegalChars;
};
 
using AnalysisDataService = Mantid::Kernel::SingletonHolder<AnalysisDataServiceImpl>;
 
using WorkspaceAddNotification = Mantid::Kernel::DataService<Mantid::API::Workspace>::AddNotification;
using WorkspaceAddNotification_ptr =
    const Poco::AutoPtr<Mantid::Kernel::DataService<Mantid::API::Workspace>::AddNotification> &;
 
using WorkspaceBeforeReplaceNotification =
    Mantid::Kernel::DataService<Mantid::API::Workspace>::BeforeReplaceNotification;
using WorkspaceBeforeReplaceNotification_ptr =
    const Poco::AutoPtr<Mantid::Kernel::DataService<Mantid::API::Workspace>::BeforeReplaceNotification> &;
 
using WorkspaceAfterReplaceNotification = Mantid::Kernel::DataService<Mantid::API::Workspace>::AfterReplaceNotification;
using WorkspaceAfterReplaceNotification_ptr =
    const Poco::AutoPtr<Mantid::Kernel::DataService<Mantid::API::Workspace>::AfterReplaceNotification> &;
 
using WorkspacePreDeleteNotification = Mantid::Kernel::DataService<Mantid::API::Workspace>::PreDeleteNotification;
using WorkspacePreDeleteNotification_ptr =
    const Poco::AutoPtr<Mantid::Kernel::DataService<Mantid::API::Workspace>::PreDeleteNotification> &;
 
using WorkspacePostDeleteNotification = Mantid::Kernel::DataService<Mantid::API::Workspace>::PostDeleteNotification;
using WorkspacePostDeleteNotification_ptr =
    const Poco::AutoPtr<Mantid::Kernel::DataService<Mantid::API::Workspace>::PostDeleteNotification> &;
 
using ClearADSNotification = Mantid::Kernel::DataService<Mantid::API::Workspace>::ClearNotification;
using ClearADSNotification_ptr =
    const Poco::AutoPtr<Mantid::Kernel::DataService<Mantid::API::Workspace>::ClearNotification> &;
 
using WorkspaceRenameNotification = Mantid::Kernel::DataService<Mantid::API::Workspace>::RenameNotification;
using WorkspaceRenameNotification_ptr =
    const Poco::AutoPtr<Mantid::Kernel::DataService<Mantid::API::Workspace>::RenameNotification> &;
 
using WorkspacesGroupedNotification = AnalysisDataServiceImpl::GroupWorkspacesNotification;
using WorkspacesGroupedNotification_ptr = const Poco::AutoPtr<AnalysisDataServiceImpl::GroupWorkspacesNotification> &;
 
using WorkspaceUnGroupingNotification = AnalysisDataServiceImpl::UnGroupingWorkspaceNotification;
using WorkspaceUnGroupingNotification_ptr =
    const Poco::AutoPtr<AnalysisDataServiceImpl::UnGroupingWorkspaceNotification> &;
 
using GroupUpdatedNotification = AnalysisDataServiceImpl::GroupUpdatedNotification;
using GroupUpdatedNotification_ptr = const Poco::AutoPtr<AnalysisDataServiceImpl::GroupUpdatedNotification> &;
 
} // Namespace API
} // Namespace Mantid
 
namespace Mantid {
namespace Kernel {
EXTERN_MANTID_API template class MANTID_API_DLL Mantid::Kernel::SingletonHolder<Mantid::API::AnalysisDataServiceImpl>;
}
} // namespace Mantid