/scr/tee1/isis/lib/Core/DataStorage/io_interface.h

Go to the documentation of this file.

//
// C/C++ Interface: io_interface
//
// Description:
//
//
// Author: Enrico Reimer<reimer@cbs.mpg.de>, (C) 2009
//
// Copyright: See COPYING file that comes with this distribution
//
//

#ifndef IO_INTERFACE_H
#define IO_INTERFACE_H

#ifdef __cplusplus
#include <string>
#include <boost/system/system_error.hpp>
#include "image.hpp"
#include "common.hpp"
#include "../CoreUtils/istring.hpp"
#include "../CoreUtils/progressfeedback.hpp"

namespace isis
{
namespace image_io
{

class FileFormat
{
public:
    enum io_modes{read_only=1,write_only=2,both=3};
protected:
    static bool setGender( util::PropertyMap &object, const char *set,const char *entries="female,male,other" );
    static bool hasOrTell( const util::PropertyMap::KeyType &name, const util::PropertyMap &object, LogLevel level );
    template<typename TYPE> static bool
    transformOrTell( const util::PropertyMap::KeyType &from, const util::PropertyMap::KeyType &to, util::PropertyMap &object, LogLevel level ) {
        if ( hasOrTell( from, object, level ) and object.transform<TYPE>( from, to ) ) {
            LOG( Debug, verbose_info ) << "Transformed " << from << " into " << object.propertyValue( to );
            return true;
        }

        return false;
    }
    virtual util::istring suffixes(io_modes modes=both)const = 0;
    static const float invalid_float;
public:
    static void throwGenericError( std::string desc );
    static void throwSystemError( int err, std::string desc = "" );
    boost::filesystem::path plugin_file;

    virtual std::pair<std::string, std::string> makeBasename( const std::string &filename )const;

    static std::string makeFilename(const util::PropertyMap &img,std::string namePattern);
    std::list<std::string> makeUniqueFilenames( const std::list<data::Image> &images, const std::string &namePattern )const;


    virtual std::string getName()const = 0;

    std::list<util::istring> getSuffixes(io_modes mode = both)const;


    virtual util::istring dialects( const std::string &/*filename*/ )const {return util::istring();};

    virtual bool tainted()const {return true;}

    virtual int load( std::list<data::Chunk> &chunks, const std::string &filename, const util::istring &dialect, boost::shared_ptr<util::ProgressFeedback> feedback )
    throw( std::runtime_error & ) = 0; //@todo should be locked

    virtual void write( const data::Image &image, const std::string &filename, const util::istring &dialect, boost::shared_ptr<util::ProgressFeedback> feedback )
    throw( std::runtime_error & ) = 0;

    virtual void write( const std::list<data::Image> &images, const std::string &filename, const util::istring &dialect, boost::shared_ptr<util::ProgressFeedback> feedback )
    throw( std::runtime_error & );

    virtual ~FileFormat() {}
};
}
}
#else
typedef struct FileFormat FileFormat;
#endif


#ifdef __cplusplus
extern "C" {
#endif

#if defined(__STDC__) || defined(__cplusplus)
#ifdef WIN32
    extern __declspec( dllexport ) isis::image_io::FileFormat *factory();
#else
    extern isis::image_io::FileFormat *factory();
#endif
#else
#ifdef WIN32
    extern __declspec( dllexport ) FileFormat *factory();
#else
    extern FileFormat *factory();
#endif
#endif

#ifdef __cplusplus
}
#endif

#endif //IO_INTERFACE_H