mitkIDataStorageService.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 mitkIDataStorageService_h
#define mitkIDataStorageService_h
 
#include <MitkCoreExports.h>
#include <mitkDataStorage.h>
#include <mitkDataStorageReference.h>
#include <mitkServiceInterface.h>
#include <mitkStorageThreadDispatcherBase.h>
 
#include <optional>
#include <string>
#include <vector>
 
namespace mitk
{
  class MITKCORE_EXPORT IDataStorageService
  {
  public:
    virtual ~IDataStorageService();
 
    virtual DataStorage::Pointer GetDefaultDataStorage() const = 0;
 
    virtual DataStorage::Pointer GetActiveDataStorage() const = 0;
 
    virtual DataStorageReference GetActiveDataStorageReference() const = 0;
 
    virtual bool SetActiveDataStorage(const std::string& label) = 0;
 
    virtual bool AddDataStorage(const std::string& label, DataStorage::Pointer storage) = 0;
 
    virtual std::optional<DataStorageReference> CreateDataStorage(const std::string& label) = 0;
 
    virtual std::optional<DataStorageReference> GetDataStorageReference(const std::string& label) const = 0;
 
    virtual std::optional<std::string> GetLabel(const DataStorage* storage) const = 0;
 
    virtual std::vector<std::string> GetAllLabels() const = 0;
 
    virtual std::vector<DataStorageReference> GetAllDataStorages() const = 0;
 
    virtual bool HasDataStorage(const std::string& label) const = 0;
 
    virtual bool RemoveDataStorage(const std::string& label) = 0;
 
    virtual StorageThreadDispatcherBase* GetDispatcher() const = 0;
  };
 
} // namespace mitk
 
MITK_DECLARE_SERVICE_INTERFACE(mitk::IDataStorageService, "org.mitk.IDataStorageService")
 
#endif