mitkAbstractFileReader.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 AbstractFileReader_H_HEADER_INCLUDED_C1E7E521
#define AbstractFileReader_H_HEADER_INCLUDED_C1E7E521

// Macro
#include <MitkCoreExports.h>

// MITK
#include <mitkBaseData.h>
#include <mitkIFileReader.h>
#include <mitkMimeType.h>

// Microservices
#include <usGetModuleContext.h>
#include <usServiceProperties.h>
#include <usServiceRegistration.h>

namespace us
{
  struct PrototypeServiceFactory;
}

namespace mitk
{
  class CustomMimeType;

  class MITKCORE_EXPORT AbstractFileReader : public mitk::IFileReader
  {
  public:
    void SetInput(const std::string &location) override;

    void SetInput(const std::string &location, std::istream *is) override;

    std::string GetInputLocation() const override;

    std::istream *GetInputStream() const override;

    MimeType GetRegisteredMimeType() const;

    std::vector<itk::SmartPointer<BaseData>> Read() override = 0;

    DataStorage::SetOfObjects::Pointer Read(mitk::DataStorage &ds) override;

    ConfidenceLevel GetConfidenceLevel() const override;

    Options GetOptions() const override;
    us::Any GetOption(const std::string &name) const override;

    void SetOptions(const Options &options) override;
    void SetOption(const std::string &name, const us::Any &value) override;

    void AddProgressCallback(const ProgressCallback &callback) override;

    void RemoveProgressCallback(const ProgressCallback &callback) override;

    us::ServiceRegistration<IFileReader> RegisterService(us::ModuleContext *context = us::GetModuleContext());
    void UnregisterService();

    std::vector< std::string > GetReadFiles() override;

  protected:
    class MITKCORE_EXPORT InputStream : public std::istream
    {
    public:
      InputStream(IFileReader *writer, std::ios_base::openmode mode = std::ios_base::in);
      ~InputStream() override;

    private:
      std::istream *m_Stream;
    };

    AbstractFileReader();
    ~AbstractFileReader() override;

    AbstractFileReader(const AbstractFileReader &other);

    explicit AbstractFileReader(const CustomMimeType &mimeType, const std::string &description);

    virtual us::ServiceProperties GetServiceProperties() const;

    virtual us::ServiceRegistration<CustomMimeType> RegisterMimeType(us::ModuleContext *context);

    void SetMimeType(const CustomMimeType &mimeType);

    const CustomMimeType *GetMimeType() const;

    void SetMimeTypePrefix(const std::string &prefix);
    std::string GetMimeTypePrefix() const;

    void SetDescription(const std::string &description);
    std::string GetDescription() const;

    void SetDefaultOptions(const Options &defaultOptions);
    Options GetDefaultOptions() const;

    void SetRanking(int ranking);
    int GetRanking() const;

    std::string GetLocalFileName() const;

    virtual void SetDefaultDataNodeProperties(DataNode *node, const std::string &filePath);

    std::vector< std::string > m_ReadFiles;

  private:
    AbstractFileReader &operator=(const AbstractFileReader &other);

    virtual mitk::IFileReader *Clone() const = 0;

    class Impl;
    std::unique_ptr<Impl> d;
  };

} // namespace mitk

#endif /* AbstractFileReader_H_HEADER_INCLUDED_C1E7E521 */