MeVisLab Toolbox Reference
mlXYLibReaderPlugin.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 "XYLibHeader.h"
18
19#include <FMEThirdPartyWarningsDisable.h>
20#include <string>
21#include <FMEThirdPartyWarningsRestore.h>
22
23
24ML_START_NAMESPACE
25
27class SubImage;
28class PagedImage;
29
30//----------------------------------------------------------------------------------
32//----------------------------------------------------------------------------------
34public:
36 static std::string getStringIdentifier();
37
40
43
47 bool isSupported(const std::string &fileName) const override;
48
54 double getPluginPriority() const override;
55
62 MLErrorCode loadFile(const std::string &fileName) override;
63
66 size_t getNumberOfImagesInFile() override;
67
71
84 MLErrorCode fillSubImage(SubImage &dstSubImage) override;
85
88 std::string getTagDump(const size_t maxNumBinaryEntries=8,
89 const size_t maxNumStringEntries=20) override;
90
93 void close() override;
94
97
99 virtual const XYLibHeader &getHeader() const;
100
101private:
102
104 void _reset();
105
107 PagedImage _imgProps;
108
110 XYLibHeader _header;
111
113 MLErrorCode _headerLoadCode;
114
117};
118
119ML_END_NAMESPACE
Project global and OS specific declarations.
#define MLXYLibReaderPlugin_EXPORT
DLL export macro definition.
Interface of a header loader for Fraunhofer EZRT (.raw and .rek) images.
FileReaderPluginsBase()
Constructor.
Header information loader for files supported by xylib.
Definition XYLibHeader.h:27
XYLibReaderPlugin()
Constructor.
static std::string getStringIdentifier()
Returns the string identifier for this plugin.
MLErrorCode loadFile(const std::string &fileName) override
double getPluginPriority() const override
std::string getTagDump(const size_t maxNumBinaryEntries=8, const size_t maxNumStringEntries=20) override
MLErrorCode fillSubImage(SubImage &dstSubImage) override
void close() override
bool isSupported(const std::string &fileName) const override
bool supportsFillingInReferenceCoordinates() const override
Returns true if the loader instance support SubImage filling in reference coordinates,...
virtual const XYLibHeader & getHeader() const
For convenience allow access to _header.
~XYLibReaderPlugin() override
Destructor. If still open the the file will also be closed.
const PagedImage & getPagedImageProperties() override
size_t getNumberOfImagesInFile() override
MLint32 MLErrorCode
Type of an ML Error code.
Definition mlTypeDefs.h:715
Header file of base class for a generic file reader plugin with factory interface.
#define ML_CLASS_HEADER(className)