IOFormat.h

Go to the documentation of this file.

// Add following header comment to force Doxygen to generate documentation
// for methods which are directly in ioformat namespace without belonging to a
// class. Doxygen limitation.
#pragma once
 
#include <memory>
#include <string>
 
#include <ioformat/IOFormatAPI.h>
#include <iolink/Uri.h>
#include <iolink/storage/DataAccess.h>
#include <iolink/view/ImageView.h>
#include <iolink/view/View.h>
#include <iolink/writer/Writer.h>
 
namespace ioformat
{
 
IOFORMAT_API bool init();
 
IOFORMAT_API std::shared_ptr<iolink::View> openView(const std::string& pathFile);
 
IOFORMAT_API std::shared_ptr<iolink::View> openView(const std::string& path, const std::string& format);
 
IOFORMAT_API std::shared_ptr<iolink::View> openView(const iolink::Uri& uri);
 
IOFORMAT_API std::shared_ptr<iolink::View> openView(const iolink::Uri& uri, const std::string& format);
 
IOFORMAT_API std::shared_ptr<iolink::ImageView> readImage(const std::string& pathFile);
 
IOFORMAT_API std::shared_ptr<iolink::View> openView(std::shared_ptr<iolink::DataAccess> storage,
                                                    const std::string& format);
 
IOFORMAT_API std::shared_ptr<iolink::Writer> openWriter(std::shared_ptr<iolink::View> view,
                                                        const std::string& pathFile);
 
IOFORMAT_API std::shared_ptr<iolink::Writer> openWriter(std::shared_ptr<iolink::View> view,
                                                        std::shared_ptr<iolink::DataAccess> dst,
                                                        const std::string& format);
 
IOFORMAT_API std::shared_ptr<iolink::Writer> openWriter(std::shared_ptr<iolink::View> view,
                                                        std::shared_ptr<iolink::DataAccess> dst,
                                                        const std::string& format,
                                                        const std::string& plugin);
 
IOFORMAT_API void writeView(std::shared_ptr<iolink::View> view, const std::string& pathFile);
 
IOFORMAT_API void writeView(std::shared_ptr<iolink::View> view,
                            std::shared_ptr<iolink::DataAccess> dst,
                            const std::string& format);
 
IOFORMAT_API std::string formatFromExtension(const std::string& extension);
 
} // namespace ioformat