mitkFileReaderWriterBase.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 mitkFileReaderWriterBase_h
#define mitkFileReaderWriterBase_h
 
#include <mitkCustomMimeType.h>
#include <mitkMessage.h>
 
#include <usAny.h>
#include <usModuleContext.h>
#include <usServiceRegistration.h>
 
#include <memory>
 
namespace mitk
{
  class FileReaderWriterBase
  {
  public:
    typedef std::map<std::string, us::Any> Options;
 
    typedef mitk::MessageAbstractDelegate1<float> ProgressCallback;
 
    FileReaderWriterBase();
    virtual ~FileReaderWriterBase();
 
    Options GetOptions() const;
 
    us::Any GetOption(const std::string &name) const;
 
    void SetOptions(const Options &options);
 
    void SetOption(const std::string &name, const us::Any &value);
 
    void SetDefaultOptions(const Options &defaultOptions);
 
    Options GetDefaultOptions() const;
 
    void SetRanking(int ranking);
 
    int GetRanking() const;
 
    void SetMimeType(const CustomMimeType &mimeType);
 
    const CustomMimeType *GetMimeType() const;
 
    CustomMimeType *GetMimeType();
 
    MimeType GetRegisteredMimeType() const;
 
    void SetMimeTypePrefix(const std::string &prefix);
 
    std::string GetMimeTypePrefix() const;
 
    void SetDescription(const std::string &description);
 
    std::string GetDescription() const;
 
    void AddProgressCallback(const ProgressCallback &callback);
 
    void RemoveProgressCallback(const ProgressCallback &callback);
 
    us::ServiceRegistration<CustomMimeType> RegisterMimeType(us::ModuleContext *context);
 
    void UnregisterMimeType();
 
  protected:
    FileReaderWriterBase(const FileReaderWriterBase &other);
 
    std::string m_Description;
    int m_Ranking;
 
    std::string m_MimeTypePrefix;
 
    Options m_Options;
 
    Options m_DefaultOptions;
 
    // us::PrototypeServiceFactory* m_PrototypeFactory;
 
    Message1<float> m_ProgressMessage;
 
    std::unique_ptr<CustomMimeType> m_CustomMimeType;
    us::ServiceRegistration<CustomMimeType> m_MimeTypeReg;
 
  private:
    // purposely not implemented
    FileReaderWriterBase &operator=(const FileReaderWriterBase &other);
  };
}
 
#endif