mitkAbstractFileWriter.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 AbstractFileWriter_H_HEADER_INCLUDED_C1E7E521
#define AbstractFileWriter_H_HEADER_INCLUDED_C1E7E521

// Macro
#include <MitkCoreExports.h>

// MITK
#include <mitkIFileWriter.h>
#include <mitkMimeType.h>

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

#include <memory>

namespace us
{
  struct PrototypeServiceFactory;
}

namespace mitk
{
  class CustomMimeType;

  class MITKCORE_EXPORT AbstractFileWriter : public mitk::IFileWriter
  {
  public:
    void SetInput(const BaseData *data) override;
    const BaseData *GetInput() const override;

    void SetOutputLocation(const std::string &location) override;
    std::string GetOutputLocation() const override;

    void SetOutputStream(const std::string &location, std::ostream *os) override;
    std::ostream *GetOutputStream() const override;

    void Write() override = 0;

    ConfidenceLevel GetConfidenceLevel() const override;

    MimeType GetRegisteredMimeType() const;

    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<IFileWriter> RegisterService(us::ModuleContext *context = us::GetModuleContext());
    void UnregisterService();

  protected:
    class MITKCORE_EXPORT LocalFile
    {
    public:
      LocalFile(IFileWriter *writer);

      // Writes to the ostream and removes the temporary file
      ~LocalFile();

      // Creates a temporary file for output operations.
      std::string GetFileName();

    private:
      // disabled
      LocalFile();
      LocalFile(const LocalFile &);
      LocalFile &operator=(const LocalFile &other);

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

    class MITKCORE_EXPORT OutputStream : public std::ostream
    {
    public:
      OutputStream(IFileWriter *writer, std::ios_base::openmode mode = std::ios_base::trunc | std::ios_base::out);
      ~OutputStream() override;

    private:
      std::ostream *m_Stream;
    };

    ~AbstractFileWriter() override;

    AbstractFileWriter(const AbstractFileWriter &other);

    AbstractFileWriter(const std::string &baseDataType);

    AbstractFileWriter(const std::string &baseDataType, 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;

    void SetBaseDataType(const std::string &baseDataType);
    virtual std::string GetBaseDataType() const;

    void ValidateOutputLocation() const;

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

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

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

} // namespace mitk

#endif /* AbstractFileWriter_H_HEADER_INCLUDED_C1E7E521 */