MeVisLab Toolbox Reference
mlDMFileReaderPlugin.h
Go to the documentation of this file.
1// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
2// **InsertLicense** code
3//----------------------------------------------------------------------------------
5
10//----------------------------------------------------------------------------------
11#pragma once
12
14#include <mlModuleIncludes.h>
15#include <mlTypeDefs.h>
17#include <mlDMFileReader.h>
18#include <FMEThirdPartyWarningsDisable.h>
19#include <string>
20#include <FMEThirdPartyWarningsRestore.h>
21
22ML_START_NAMESPACE
23
25class SubImage;
26class PagedImage;
27
28//----------------------------------------------------------------------------------
30//----------------------------------------------------------------------------------
32public:
34 static std::string getStringIdentifier();
35
38
41
45 bool isSupported(const std::string &fileName) const override;
46
53 MLErrorCode loadFile(const std::string &fileName) override;
54
57 size_t getNumberOfImagesInFile() override;
58
62
75 MLErrorCode fillSubImage(SubImage &dstSubImage) override;
76
84 std::string getTagDump(const size_t maxNumBinaryEntries=8,
85 const size_t maxNumStringEntries=20) override;
86
89 void close() override;
90
93
94private:
96 std::string _fileName;
97
99 DMFileReader _reader;
100
103};
104
105ML_END_NAMESPACE
Project global and OS specific declarations.
#define MLFileReaderPlugins_EXPORT
DLL export macro definition.
DMFileReaderPlugin()
Constructor.
MLErrorCode fillSubImage(SubImage &dstSubImage) override
~DMFileReaderPlugin() override
Destructor. If still open the the file will also be closed.
bool supportsFillingInReferenceCoordinates() const override
Returns true if the loader instance support SubImage filling in reference coordinates,...
void close() override
static std::string getStringIdentifier()
Returns the string identifier for this plugin.
bool isSupported(const std::string &fileName) const override
MLErrorCode loadFile(const std::string &fileName) override
size_t getNumberOfImagesInFile() override
std::string getTagDump(const size_t maxNumBinaryEntries=8, const size_t maxNumStringEntries=20) override
const PagedImage & getPagedImageProperties() override
A tool classes to load Digital Microscopy files.
FileReaderPluginsBase()
Constructor.
MLint32 MLErrorCode
Type of an ML Error code.
Definition mlTypeDefs.h:715
Tool classes to load Digital Micrograph (.dm) files.
Header file of base class for a generic file reader plugin with factory interface.
#define ML_CLASS_HEADER(className)