Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::AbstractFileIOReader Class Referenceabstract

#include <mitkAbstractFileIO.h>

Inheritance diagram for mitk::AbstractFileIOReader:
Collaboration diagram for mitk::AbstractFileIOReader:

Public Member Functions

virtual ConfidenceLevel GetReaderConfidenceLevel () const
 
virtual ConfidenceLevel GetConfidenceLevel () const override
 The confidence level of the reader or writer implementation. More...
 
- Public Member Functions inherited from mitk::AbstractFileReader
virtual void SetInput (const std::string &location) override
 Set the input location. More...
 
virtual void SetInput (const std::string &location, std::istream *is) override
 Set an input stream to read from. More...
 
virtual std::string GetInputLocation () const override
 Get the current input location. More...
 
virtual std::istream * GetInputStream () const override
 Get the input stream. More...
 
MimeType GetRegisteredMimeType () const
 
virtual std::vector< itk::SmartPointer< BaseData > > Read () override=0
 Reads a path or stream and creates a list of BaseData objects. More...
 
virtual DataStorage::SetOfObjects::Pointer Read (mitk::DataStorage &ds) override
 Reads the specified file or input stream, loading its contents into the provided DataStorage. More...
 
virtual Options GetOptions () const override
 returns a list of the supported options More...
 
virtual us::Any GetOption (const std::string &name) const override
 
virtual void SetOptions (const Options &options) override
 
virtual void SetOption (const std::string &name, const us::Any &value) override
 
virtual void AddProgressCallback (const ProgressCallback &callback) override
 
virtual void RemoveProgressCallback (const ProgressCallback &callback) override
 
us::ServiceRegistration< IFileReaderRegisterService (us::ModuleContext *context=us::GetModuleContext())
 
void UnregisterService ()
 
- Public Member Functions inherited from mitk::IFileReader
virtual ~IFileReader ()
 
- Public Member Functions inherited from mitk::IFileIO
virtual ~IFileIO ()
 

Protected Member Functions

 AbstractFileIOReader ()
 
 AbstractFileIOReader (const CustomMimeType &mimeType, const std::string &description)
 
- Protected Member Functions inherited from mitk::AbstractFileReader
 AbstractFileReader ()
 
 ~AbstractFileReader ()
 
 AbstractFileReader (const AbstractFileReader &other)
 
 AbstractFileReader (const CustomMimeType &mimeType, const std::string &description)
 
virtual us::ServiceProperties GetServiceProperties () const
 
virtual us::ServiceRegistration< CustomMimeTypeRegisterMimeType (us::ModuleContext *context)
 
void SetMimeType (const CustomMimeType &mimeType)
 
const CustomMimeTypeGetMimeType () const
 
void SetMimeTypePrefix (const std::string &prefix)
 
std::string GetMimeTypePrefix () const
 
void SetDescription (const std::string &description)
 
std::string GetDescription () const
 
void SetDefaultOptions (const Options &defaultOptions)
 
Options GetDefaultOptions () const
 
void SetRanking (int ranking)
 Set the service ranking for this file reader. More...
 
int GetRanking () const
 
std::string GetLocalFileName () const
 Get a local file name for reading. More...
 
virtual void SetDefaultDataNodeProperties (DataNode *node, const std::string &filePath)
 

Additional Inherited Members

- Public Types inherited from mitk::IFileIO
enum  ConfidenceLevel { Unsupported, PartiallySupported, Supported }
 A confidence level describing the confidence of the reader or writer in handling the given data. More...
 
typedef std::map< std::string, us::AnyOptions
 Options for reading or writing data. More...
 
typedef mitk::MessageAbstractDelegate1< float > ProgressCallback
 
- Static Public Member Functions inherited from mitk::IFileIO
static std::string PROP_DESCRIPTION ()
 Service property name for a description. More...
 
static std::string PROP_MIMETYPE ()
 Service property name for the mime-type associated with this file writer. More...
 

Detailed Description

Definition at line 31 of file mitkAbstractFileIO.h.

Constructor & Destructor Documentation

mitk::AbstractFileIOReader::AbstractFileIOReader ( )
inlineprotected

Definition at line 37 of file mitkAbstractFileIO.h.

mitk::AbstractFileIOReader::AbstractFileIOReader ( const CustomMimeType mimeType,
const std::string &  description 
)
inlineprotected

Definition at line 38 of file mitkAbstractFileIO.h.

Member Function Documentation

virtual ConfidenceLevel mitk::AbstractFileIOReader::GetConfidenceLevel ( ) const
inlineoverridevirtual

The confidence level of the reader or writer implementation.

Returns
Confidence level.

The level is used to rank multiple competing implementations.

Reimplemented from mitk::AbstractFileReader.

Definition at line 35 of file mitkAbstractFileIO.h.

References GetReaderConfidenceLevel().


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