Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
mitk::FileReaderRegistry Class Reference
MITK Modules » Core » IO Classes

#include <mitkFileReaderRegistry.h>

Public Types

typedef us::ServiceReference< IFileReader > ReaderReference
 

Public Member Functions

 FileReaderRegistry ()
 
 ~FileReaderRegistry ()
 
mitk::IFileReader * GetReader (const ReaderReference &ref, us::ModuleContext *context=us::GetModuleContext())
 
std::vector< mitk::IFileReader * > GetReaders (const MimeType &mimeType, us::ModuleContext *context=us::GetModuleContext())
 
void UngetReader (mitk::IFileReader *reader)
 
void UngetReaders (const std::vector< mitk::IFileReader * > &readers)
 

Static Public Member Functions

static MimeType GetMimeTypeForFile (const std::string &path, us::ModuleContext *context=us::GetModuleContext())
 Get the highest ranked mime-type for the given file name. More...
 
static std::vector< ReaderReference > GetReferences (const MimeType &mimeType, us::ModuleContext *context=us::GetModuleContext())
 

Detailed Description

Provides convenient access to mitk::IFileReader instances and reading files into mitk::BaseData types.

Note
The life-time of all mitk::IFileReader objects returned by an instance of this class ends with the destruction of that instance.

Definition at line 43 of file mitkFileReaderRegistry.h.

Member Typedef Documentation

typedef us::ServiceReference<IFileReader> mitk::FileReaderRegistry::ReaderReference

Definition at line 46 of file mitkFileReaderRegistry.h.

Constructor & Destructor Documentation

mitk::FileReaderRegistry::FileReaderRegistry ( )

Definition at line 30 of file mitkFileReaderRegistry.cpp.

mitk::FileReaderRegistry::~FileReaderRegistry ( )

Definition at line 34 of file mitkFileReaderRegistry.cpp.

Member Function Documentation

mitk::MimeType mitk::FileReaderRegistry::GetMimeTypeForFile ( const std::string &  path,
us::ModuleContext *  context = us::GetModuleContext() 
)
static

Get the highest ranked mime-type for the given file name.

Parameters
extensionA file name extension without a leading dot.
context
Returns
The highest ranked mime-type containing extension in its extension list.

Definition at line 42 of file mitkFileReaderRegistry.cpp.

References mitk::CoreServices::GetMimeTypeProvider(), mitk::IMimeTypeProvider::GetMimeTypesForFile(), and mitkThrow.

Referenced by mitkPointSetReaderTest().

mitk::IFileReader * mitk::FileReaderRegistry::GetReader ( const ReaderReference &  ref,
us::ModuleContext *  context = us::GetModuleContext() 
)

Definition at line 73 of file mitkFileReaderRegistry.cpp.

References us::GetModuleContext(), and us::ServiceObjects< S >::GetService().

Referenced by mitk::IOUtil::Load().

std::vector< mitk::IFileReader * > mitk::FileReaderRegistry::GetReaders ( const MimeType &  mimeType,
us::ModuleContext *  context = us::GetModuleContext() 
)

Definition at line 85 of file mitkFileReaderRegistry.cpp.

References us::GetModuleContext(), us::ServiceObjects< S >::GetService(), and mitk::MimeType::IsValid().

Referenced by mitkPointSetReaderTest().

std::vector< mitk::FileReaderRegistry::ReaderReference > mitk::FileReaderRegistry::GetReferences ( const MimeType &  mimeType,
us::ModuleContext *  context = us::GetModuleContext() 
)
static

Definition at line 62 of file mitkFileReaderRegistry.cpp.

References us::GetModuleContext(), mitk::MimeType::GetName(), us::ServiceConstants::OBJECTCLASS(), and mitk::IFileIO::PROP_MIMETYPE().

Referenced by mitk::IOUtil::Load().

void mitk::FileReaderRegistry::UngetReader ( mitk::IFileReader *  reader)

Definition at line 115 of file mitkFileReaderRegistry.cpp.

void mitk::FileReaderRegistry::UngetReaders ( const std::vector< mitk::IFileReader * > &  readers)

Definition at line 126 of file mitkFileReaderRegistry.cpp.

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