OpenStructure
Public Member Functions
IOManager Class Reference

#include <io_manager.hh>

Public Member Functions

EntityIOHandlerP FindEntityImportHandler (const String &filename, const String &format="auto")
 
EntityIOHandlerP FindEntityExportHandler (const String &filename, const String &format="auto")
 
Alignment/Sequence IO
SequenceIOHandlerPtr FindAlignmentImportHandler (const String &filename, const String &format="auto")
 
SequenceIOHandlerPtr FindAlignmentExportHandler (const String &filename, const String &format="auto")
 
ProfileIOHandlerPtr FindProfileImportHandler (const String &filename, const String &format="auto")
 
ProfileIOHandlerPtr FindProfileExportHandler (const String &filename, const String &format="auto")
 
SurfaceIOHandlerPtr FindSurfaceImportHandler (const String &filename, const String &format="auto")
 
void RegisterFactory (const EntityIOHandlerFactoryBaseP &)
 
void RegisterFactory (const SequenceIOHandlerFactoryBasePtr &)
 
void RegisterFactory (const ProfileIOHandlerFactoryBasePtr &)
 
void RegisterFactory (const SurfaceIOHandlerFactoryBasePtr &)
 
const EntityIOHFListGetAvailableEntityHandler () const
 
const AlignmentIOFListGetAvailableAlignmentHandler () const
 
const ProfileIOFListGetAvailableProfileHandler () const
 
const SurfaceIOFListGetAvailableSurfaceHandler () const
 

Image/Map IO

void RegisterFactory (const MapIOHandlerFactoryBasePtr &)
 
MapIOHandlerPtr FindMapImportHandlerFile (const boost::filesystem::path &loc, const ImageFormatBase &format)
 
MapIOHandlerPtr FindMapImportHandlerStream (std::istream &stream, const ImageFormatBase &format)
 
MapIOHandlerPtr FindMapExportHandlerFile (const boost::filesystem::path &loc, const ImageFormatBase &format)
 
MapIOHandlerPtr FindMapExportHandlerStream (std::istream &stream, const ImageFormatBase &format)
 
const MapIOFListGetAvailableMapHandler () const
 
static IOManagerInstance ()
 

Detailed Description

Central registry for input/output handlers.

Definition at line 44 of file io_manager.hh.

Member Function Documentation

◆ FindAlignmentExportHandler()

SequenceIOHandlerPtr FindAlignmentExportHandler ( const String filename,
const String format = "auto" 
)

◆ FindAlignmentImportHandler()

SequenceIOHandlerPtr FindAlignmentImportHandler ( const String filename,
const String format = "auto" 
)

get sequence io handler that is able to import the given file.

See also
FindEntityImportHandler(filename)

◆ FindEntityExportHandler()

EntityIOHandlerP FindEntityExportHandler ( const String filename,
const String format = "auto" 
)

get entity IO handler that is able to export the file.

Note
The same rules as for FindEntityImportHandler(const String&, const String&) apply here.

◆ FindEntityImportHandler()

EntityIOHandlerP FindEntityImportHandler ( const String filename,
const String format = "auto" 
)

◆ FindMapExportHandlerFile()

MapIOHandlerPtr FindMapExportHandlerFile ( const boost::filesystem::path &  loc,
const ImageFormatBase format 
)

◆ FindMapExportHandlerStream()

MapIOHandlerPtr FindMapExportHandlerStream ( std::istream &  stream,
const ImageFormatBase format 
)

◆ FindMapImportHandlerFile()

MapIOHandlerPtr FindMapImportHandlerFile ( const boost::filesystem::path &  loc,
const ImageFormatBase format 
)

◆ FindMapImportHandlerStream()

MapIOHandlerPtr FindMapImportHandlerStream ( std::istream &  stream,
const ImageFormatBase format 
)

◆ FindProfileExportHandler()

ProfileIOHandlerPtr FindProfileExportHandler ( const String filename,
const String format = "auto" 
)

◆ FindProfileImportHandler()

ProfileIOHandlerPtr FindProfileImportHandler ( const String filename,
const String format = "auto" 
)

◆ FindSurfaceImportHandler()

SurfaceIOHandlerPtr FindSurfaceImportHandler ( const String filename,
const String format = "auto" 
)

◆ GetAvailableAlignmentHandler()

const AlignmentIOFList& GetAvailableAlignmentHandler ( ) const

Get a list with all available AlignmentHandler.

◆ GetAvailableEntityHandler()

const EntityIOHFList& GetAvailableEntityHandler ( ) const

Get a list with all available EntityHandler.

◆ GetAvailableMapHandler()

const MapIOFList& GetAvailableMapHandler ( ) const

◆ GetAvailableProfileHandler()

const ProfileIOFList& GetAvailableProfileHandler ( ) const

Get a list with all available ProfileHandler.

◆ GetAvailableSurfaceHandler()

const SurfaceIOFList& GetAvailableSurfaceHandler ( ) const

Get a list with all available SurfaceHandler.

◆ Instance()

static IOManager& Instance ( )
static

◆ RegisterFactory() [1/5]

void RegisterFactory ( const EntityIOHandlerFactoryBaseP )

register entity io handler factory

See also
adding_io_handler

◆ RegisterFactory() [2/5]

void RegisterFactory ( const MapIOHandlerFactoryBasePtr )

register map io handle factory

See also
adding_io_handler

◆ RegisterFactory() [3/5]

void RegisterFactory ( const ProfileIOHandlerFactoryBasePtr )

register profile io handler factory

See also
adding_io_handler

◆ RegisterFactory() [4/5]

void RegisterFactory ( const SequenceIOHandlerFactoryBasePtr )

register aligment io handler factory

See also
adding_io_handler

◆ RegisterFactory() [5/5]

void RegisterFactory ( const SurfaceIOHandlerFactoryBasePtr )

register surface io handler factory

See also
adding_io_handler

The documentation for this class was generated from the following file: