ioplugin.hh

Go to the documentation of this file.

/* -*- mia-c++  -*-
 *
 * This file is part of MIA - a toolbox for medical image analysis 
 * Copyright (c) Leipzig, Madrid 1999-2017 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

struct EXPORT_CORE io_plugin_type {
        static  const char *type_descr;

};

template <typename D>
class EXPORT_HANDLER TIOPlugin: public TPlugin<D, io_plugin_type> {

public:
        typedef  typename D::type Data;
        
        typedef  typename std::shared_ptr<Data > PData;

        typedef  std::set<EPixelType> PixelTypeSet;

        typedef  std::set<std::string> SuffixSet;


        TIOPlugin(const char *name);

        void add_suffixes(std::multimap<std::string, std::string>& map) const;

        PData load(const std::string& fname) const;

        bool save(const std::string& fname, const Data& data) const;

        const PixelTypeSet& supported_pixel_types() const;



        const std::string get_preferred_suffix() const; 
protected:

        void add_suffix(const std::string& suffix);  
        const SuffixSet& get_suffixes() const; 

        void add_supported_type(EPixelType t);
private:
        PixelTypeSet m_typeset;

        SuffixSet m_suffixes; 

        virtual PData do_load(const std::string& fname) const = 0;

        void do_get_help_xml(CXMLElement& root) const; 


        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