/usr/include/mia-2.2/mia/core/ioplugin.hh is in libmia-2.2-dev 2.2.2-1+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 | /* -*- mia-c++ -*-
*
* This file is part of MIA - a toolbox for medical image analysis
* Copyright (c) Leipzig, Madrid 1999-2014 Gert Wollny
*
* MIA is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with MIA; if not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef ph_ioplugin_hh
#define ph_ioplugin_hh
#include <set>
#include <mia/core/plugin_base.hh>
#include <mia/core/pixeltype.hh>
#include <mia/core/iodata.hh>
NS_MIA_BEGIN
/**
\cond INTERNAL
\ingroup plugin
*/
struct EXPORT_CORE io_plugin_type {
static const char *type_descr;
};
/// \endcond
/**
\ingroup plugin
\brief The templatex basis class of all IO plug-ins.
The basis of all IO plug-ins. The type \a D must provied a typedef \a type the referes to the
data type to be handled and it must provied a string \a value that describes the type of
the io data and also corresponds to the last part of the directory name, where the plug-in
will be located after installation of the package.
The type D must be derived from \a CIOData, to supply functions to store and acquire the
file format used to load the data.
\tparam D the data type for witch the IO is implemented
*/
template <typename D>
class EXPORT_HANDLER TIOPlugin: public TPlugin<D, io_plugin_type> {
public:
/// type of the data handled by this plug-in
typedef typename D::type Data;
/// shared pointer of the data handled by this plug-in
typedef typename std::shared_ptr<Data > PData;
/// the type for the supported pixel types of this IO handler
typedef std::set<EPixelType> PixelTypeSet;
typedef std::set<std::string> SuffixSet;
/**
Constructor of the Plugin
\param name the name of the plug-in, should correnspond to the file type
*/
TIOPlugin(const char *name);
/**
Adds file suffixes supported by this plug-in to a map to improve loading of files.
\param map the map, the suffixes will be added to.
*/
void add_suffixes(std::multimap<std::string, std::string>& map) const;
/**
the load function, the actual implementation of the loading is implemented in do_load,
which has to be implemented in the according plug-in
\param fname the file name to be loaded
\returns a shared pointer to the loaded data, or an empty shared pointer,
if no data could be loaded.
*/
PData load(const std::string& fname) const;
/**
The save function. Saves the \a data to file \a fname. The actual save function is implemented in do_save
and needs to be provied in th eaccording IO plug-in.
\param fname file name
\param data data to be stored.
\returns true if the saving was succesfull, false otherwise
*/
bool save(const std::string& fname, const Data& data) const;
/// \returns a set of thepixel types, supported by this IO plug-in
const PixelTypeSet& supported_pixel_types() const;
/**
Translate the file type decriptor to the file suffix.
\returns preferred suffix of the file type
\remark in most cases this is just a pass-through
*/
const std::string get_preferred_suffix() const;
protected:
void add_suffix(const std::string& suffix);
const SuffixSet& get_suffixes() const;
/// add pixel type t to the list of supported types
void add_supported_type(EPixelType t);
private:
PixelTypeSet m_typeset;
SuffixSet m_suffixes;
/**
Interface function that needs to be impemented ina a derived class:
\param fname
*/
virtual PData do_load(const std::string& fname) const = 0;
void do_get_help_xml(xmlpp::Element& root) const;
/**
Interface function that needs to be impemented ina a derived class:
\param fname
\param data the data to be saved
\returns true if saveing was successfull
*/
virtual bool do_save(const std::string& fname, const typename D::type& data) const = 0;
virtual const std::string do_get_preferred_suffix() const;
};
EXPORT_CORE extern const char * const io_plugin_property_multi_record;
EXPORT_CORE extern const char * const io_plugin_property_history_split;
EXPORT_CORE extern const char * const io_plugin_property_has_attributes;
EXPORT_CORE extern const char * const io_plugin_property_can_pipe;
NS_MIA_END
#endif
|