mlFileReaderPluginsBase.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------
 
#pragma once
 
#include "MLFileReaderPluginsBaseSystem.h"
#include <mlModuleIncludes.h>
 
ML_START_NAMESPACE

class MLFileReaderPluginsBase_EXPORT FileReaderPluginsBase {
 
public:

  static FileReaderPluginsBase* createLoaderInstance(const std::string &fileName);

  FileReaderPluginsBase();
  
  virtual ~FileReaderPluginsBase();
  
  virtual bool isSupported(const std::string& fileName) const = 0;
  
  virtual double getPluginPriority() const;
  
  virtual MLErrorCode loadFile(const std::string& fileName) = 0;

  virtual size_t getNumberOfImagesInFile() = 0;

  virtual std::string getCodedImageIndexString(unsigned int imgIdx);

  virtual unsigned int extractImageIndexValue(const std::string& codedLoaderPluginString);

  virtual void setSelectedImageIndex(size_t idx = 0);

  virtual size_t getSelectedImageIndex() const;

  virtual const PagedImage &getPagedImageProperties() = 0;
  
  virtual MLErrorCode fillSubImage(SubImage &dstSubImage) = 0;
  
  virtual std::string getTagDump(const size_t maxNumBinaryEntries = 8,
                                 const size_t maxNumStringEntries = 20);
  
  virtual void close() = 0;
  
  virtual void setReferenceForFillingInReferenceCoordinates(const PagedImage* refImg = nullptr);

  virtual const PagedImage* getReferenceForFillingInReferenceCoordinates() const;

  virtual bool supportsFillingInReferenceCoordinates() const;
 
protected:
  ImageVector _determineWorldDifferenceAsVoxelShift(const PagedImage& destination) const;
  
private:
  const PagedImage* _referencePagedImage;
  
  size_t _currentImageIndex;
  
  ML_ABSTRACT_ROOT_CLASS_HEADER(FileReaderPluginsBase);
};
 
ML_END_NAMESPACE