mitkAbstractFileIO.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 mitkAbstractFileIO_h
#define mitkAbstractFileIO_h
 
#include <mitkAbstractFileReader.h>
#include <mitkAbstractFileWriter.h>
 
namespace mitk
{
#ifndef DOXYGEN_SKIP
 
  // Skip this code during Doxygen processing, because it only
  // exists to resolve name clashes when inheriting from both
  // AbstractFileReader and AbstractFileWriter.
 
  class AbstractFileIOReader : public AbstractFileReader
  {
  public:
    virtual ConfidenceLevel GetReaderConfidenceLevel() const { return AbstractFileReader::GetConfidenceLevel(); }
    ConfidenceLevel GetConfidenceLevel() const override { return this->GetReaderConfidenceLevel(); }
  protected:
    AbstractFileIOReader() {}
    AbstractFileIOReader(const CustomMimeType &mimeType, const std::string &description)
      : AbstractFileReader(mimeType, description)
    {
    }
 
  private:
    virtual IFileReader *ReaderClone() const = 0;
    IFileReader *Clone() const override { return ReaderClone(); }
  };
 
  struct AbstractFileIOWriter : public AbstractFileWriter
  {
    virtual ConfidenceLevel GetWriterConfidenceLevel() const { return AbstractFileWriter::GetConfidenceLevel(); }
    ConfidenceLevel GetConfidenceLevel() const override { return this->GetWriterConfidenceLevel(); }
  protected:
    AbstractFileIOWriter(const std::string &baseDataType) : AbstractFileWriter(baseDataType) {}
    AbstractFileIOWriter(const std::string &baseDataType,
                         const CustomMimeType &mimeType,
                         const std::string &description)
      : AbstractFileWriter(baseDataType, mimeType, description)
    {
    }
 
  private:
    virtual IFileWriter *WriterClone() const = 0;
    IFileWriter *Clone() const override { return WriterClone(); }
  };
 
#endif // DOXYGEN_SKIP
 
  class MITKCORE_EXPORT AbstractFileIO : public AbstractFileIOReader, public AbstractFileIOWriter
  {
  public:
    Options GetReaderOptions() const;
 
    us::Any GetReaderOption(const std::string &name) const;
 
    void SetReaderOptions(const Options &options);
 
    void SetReaderOption(const std::string &name, const us::Any &value);
 
    Options GetWriterOptions() const;
 
    us::Any GetWriterOption(const std::string &name) const;
 
    void SetWriterOptions(const Options &options);
 
    void SetWriterOption(const std::string &name, const us::Any &value);
 
    ConfidenceLevel GetReaderConfidenceLevel() const override;
 
    ConfidenceLevel GetWriterConfidenceLevel() const override;
 
    std::pair<us::ServiceRegistration<IFileReader>, us::ServiceRegistration<IFileWriter>> RegisterService(
      us::ModuleContext *context = us::GetModuleContext());
 
  protected:
    AbstractFileIO(const AbstractFileIO &other);
 
    AbstractFileIO(const std::string &baseDataType);
 
    explicit AbstractFileIO(const std::string &baseDataType,
                            const CustomMimeType &mimeType,
                            const std::string &description);
 
    void SetMimeType(const CustomMimeType &mimeType);
 
    const CustomMimeType *GetMimeType() const;
 
    void SetReaderDescription(const std::string &description);
 
    std::string GetReaderDescription() const;
 
    void SetWriterDescription(const std::string &description);
 
    std::string GetWriterDescription() const;
 
    void SetDefaultReaderOptions(const Options &defaultOptions);
 
    Options GetDefaultReaderOptions() const;
 
    void SetDefaultWriterOptions(const Options &defaultOptions);
 
    Options GetDefaultWriterOptions() const;
 
    void SetReaderRanking(int ranking);
 
    int GetReaderRanking() const;
 
    void SetWriterRanking(int ranking);
 
    int GetWriterRanking() const;
 
  private:
    AbstractFileIO &operator=(const AbstractFileIO &other);
 
    virtual AbstractFileIO *IOClone() const = 0;
 
    IFileReader *ReaderClone() const override;
    IFileWriter *WriterClone() const override;
  };
}
 
#endif