The common interface for all MITK file readers. More...

#include <mitkIFileReader.h>

Inheritance diagram for mitk::IFileReader:

[legend]

Collaboration diagram for mitk::IFileReader:

Public Member Functions
	~IFileReader () override

virtual void	SetInput (const std::string &location)=0
	Set the input file path. More...

virtual void	SetInput (const std::string &location, std::istream *is)=0
	Set an input stream to read from. More...

virtual std::string	GetInputLocation () const =0
	Get the current input location. More...

virtual std::istream *	GetInputStream () const =0
	Get the input stream. More...

virtual std::vector< itk::SmartPointer< BaseData > >	Read ()=0
	Read the specified file or input stream and return its contents. More...

virtual DataStorage::SetOfObjects::Pointer	Read (mitk::DataStorage &ds)=0
	Read the specified file or input stream, loading its contents into the provided DataStorage. More...

virtual std::vector< std::string >	GetReadFiles ()=0
	Get the list of files that were loaded during the last Read() call. More...

virtual void	SetProperties (const PropertyList *properties)=0
	Optionally provide base data properties as a source of meta data. More...

virtual	~IFileReader ()

virtual void	SetInput (const std::string &location)=0
	Set the input location. More...

virtual void	SetInput (const std::string &location, std::istream *is)=0
	Set an input stream to read from. More...

virtual std::string	GetInputLocation () const =0
	Get the current input location. More...

virtual std::istream *	GetInputStream () const =0
	Get the input stream. More...

virtual std::vector< itk::SmartPointer< BaseData > >	Read ()=0
	Reads the specified file or input stream and returns its contents. More...

virtual DataStorage::SetOfObjects::Pointer	Read (mitk::DataStorage &ds)=0
	Reads the specified file or input stream, loading its contents into the provided DataStorage. More...

Public Member Functions inherited from mitk::IFileIO
virtual	~IFileIO ()

virtual ConfidenceLevel	GetConfidenceLevel () const =0
	Get the confidence level of this reader or writer for the current input. More...

virtual Options	GetOptions () const =0
	Get the current options map. More...

virtual us::Any	GetOption (const std::string &name) const =0
	Get the value of a specific option. More...

virtual void	SetOptions (const Options &options)=0
	Set multiple options at once. More...

virtual void	SetOption (const std::string &name, const us::Any &value)=0
	Set the value of a specific option. More...

virtual void	AddProgressCallback (const ProgressCallback &callback)=0
	Register a progress callback. More...

virtual void	RemoveProgressCallback (const ProgressCallback &callback)=0
	Remove a previously registered progress callback. More...

Protected Member Functions
virtual const PropertyList *	GetProperties () const =0
	Get the properties set via SetProperties(). More...

Additional Inherited Members
Public Types inherited from mitk::IFileIO
enum	ConfidenceLevel { Unsupported , PartiallySupported , Supported }
	A confidence level describing the reader's or writer's ability to handle the given data or file format. More...

typedef std::map< std::string, us::Any >	Options
	Options for reading or writing data. More...

typedef mitk::MessageAbstractDelegate1< float >	ProgressCallback
	Callback delegate type for progress reporting. More...

Static Public Member Functions inherited from mitk::IFileIO
static std::string	PROP_DESCRIPTION ()
	Service property name for a human-readable description. More...

static std::string	PROP_MIMETYPE ()
	Service property name for the mime-type associated with this reader or writer. More...

Detailed Description

The common interface for all MITK file readers.

The common interface for all providers of models for fitting in mitk.

Implementations of this interface must be registered as a service to make themselves available via the service registry. If the implementation is stateful, the service should be registered using a PrototypeServiceFactory.

The file reader implementation is associated with a mime-type, specified in the service property PROP_MIMETYPE(). The specified mime-type should have a corresponding CustomMimeType service object, registered by the reader or some other party.

It is recommended to derive new implementations from AbstractFileReader or from AbstractFileIO (if both reader and writer are implemented), which provide correct service registration semantics.

See also: AbstractFileReader; AbstractFileIO; CustomMimeType; FileReaderRegistry; FileReaderSelector; IFileWriter

Implementations of this interface must be registered as a service to make themselves available via the service registry. If the implementation is state-full, the service should be registered using a PrototypeServiceFactory.

It is recommended to derive new implementations from ModelFitProviderBase, which provide correct service registration semantics.

See also: ModelFitProviderBase

Definition at line 62 of file mitkIFileReader.h.

Constructor & Destructor Documentation

◆ ~IFileReader() [1/2]

mitk::IFileReader::~IFileReader ( )

override

◆ ~IFileReader() [2/2]

virtual mitk::IFileReader::~IFileReader ( )

virtual

Member Function Documentation

◆ GetInputLocation() [1/2]

virtual std::string mitk::IFileReader::GetInputLocation ( ) const

pure virtual

Get the current input location.

Returns: The file-system path or custom label set via SetInput().

Implemented in mitk::AbstractFileReader.

◆ GetInputLocation() [2/2]

virtual std::string mitk::IFileReader::GetInputLocation ( ) const

pure virtual

Get the current input location.

Returns: The input location.

Implemented in mitk::AbstractFileReader.

◆ GetInputStream() [1/2]

virtual std::istream* mitk::IFileReader::GetInputStream ( ) const

pure virtual

Get the input stream.

Returns: The currently set input stream, or nullptr if no stream was set.

Implemented in mitk::AbstractFileReader.

◆ GetInputStream() [2/2]

virtual std::istream* mitk::IFileReader::GetInputStream ( ) const

pure virtual

Get the input stream.

Returns: The currently set input stream.

Implemented in mitk::AbstractFileReader.

◆ GetProperties()

virtual const PropertyList* mitk::IFileReader::GetProperties ( ) const

protectedpure virtual

Get the properties set via SetProperties().

Returns: The current PropertyList, or nullptr if none was set.

See also: SetProperties()

Implemented in mitk::AbstractFileReader.

◆ GetReadFiles()

virtual std::vector< std::string > mitk::IFileReader::GetReadFiles ( )

pure virtual

Get the list of files that were loaded during the last Read() call.

Returns: A list of file paths that were consumed during the most recent read operation. Must be populated by the reader implementation.

Implemented in mitk::AbstractFileReader.

◆ Read() [1/4]

virtual std::vector<itk::SmartPointer<BaseData> > mitk::IFileReader::Read ( )

pure virtual

Read the specified file or input stream and return its contents.

Returns: A list of created BaseData objects.

If GetInputStream() returns a non-null value, this method must use the returned stream object to read the data from. If no input stream was set, the data must be read from the path returned by GetInputLocation().

Exceptions

mitk::Exception if the data could not be read.

◆ Read() [2/4]

virtual std::vector<itk::SmartPointer<BaseData> > mitk::IFileReader::Read ( )

pure virtual

Reads the specified file or input stream and returns its contents.

Returns: A list of created BaseData objects.

If GetInputStream() returns a non-null value, this method must use the returned stream object to read the data from. If no input stream was set, the data must be read from the path returned by GetInputLocation().

Exceptions

mitk::Exception

◆ Read() [3/4]

virtual DataStorage::SetOfObjects::Pointer mitk::IFileReader::Read ( mitk::DataStorage & ds )

pure virtual

Read the specified file or input stream, loading its contents into the provided DataStorage.

Parameters

[in,out] ds The DataStorage to which the data is added.

Returns: The set of DataNode objects added to ds.

This method may be overridden by implementations to create or reconstruct a hierarchy of mitk::DataNode instances in the provided mitk::DataStorage.

Exceptions

mitk::Exception if the data could not be read.

Implemented in mitk::AbstractFileReader, mitk::SceneJsonFileReader, and mitk::SceneFileReader.

◆ Read() [4/4]

virtual DataStorage::SetOfObjects::Pointer mitk::IFileReader::Read ( mitk::DataStorage & ds )

pure virtual

Reads the specified file or input stream, loading its contents into the provided DataStorage.

Parameters

ds	The DataStorage to which the data is added.

Returns: The set of added DataNodes to ds.

This method may be overridden by implementations to create or reconstructed a hierarchy of mitk::DataNode instances in the provided mitk::DataStorage.

Exceptions

mitk::Exception

Implemented in mitk::AbstractFileReader, mitk::SceneJsonFileReader, and mitk::SceneFileReader.

◆ SetInput() [1/4]

virtual void mitk::IFileReader::SetInput ( const std::string & location )

pure virtual

Set the input file path.

Parameters

[in] location The absolute file-system path to read from.

This clears any previously set input stream. The given location is used as the file-system path for reading.

Implemented in mitk::AbstractFileReader.

◆ SetInput() [2/4]

virtual void mitk::IFileReader::SetInput ( const std::string & location )

pure virtual

Set the input location.

Parameters

location The file name to read from.

Implemented in mitk::AbstractFileReader.

◆ SetInput() [3/4]

virtual void mitk::IFileReader::SetInput	(	const std::string &	location,
		std::istream *	is
	)

pure virtual

Set an input stream to read from.

Parameters

[in]	location	A custom label for the input stream, or a file-system path.
[in]	is	The input stream, or `nullptr` to clear the stream.

If is is nullptr, this clears the current input stream and location is interpreted as a file-system path. Otherwise, location is a custom label describing the input stream is.

Implemented in mitk::AbstractFileReader.

◆ SetInput() [4/4]

virtual void mitk::IFileReader::SetInput	(	const std::string &	location,
		std::istream *	is
	)

pure virtual

Set an input stream to read from.

Parameters

location	A custom label for the input stream.
is	The input stream.

If is is NULL, this clears the current input stream and location is interpreted as a file-system path. Otherwise, location is a custom label describing the input stream is.

Implemented in mitk::AbstractFileReader.

◆ SetProperties()

virtual void mitk::IFileReader::SetProperties ( const PropertyList * properties )

pure virtual

Optionally provide base data properties as a source of meta data.

Parameters

[in] properties A PropertyList containing meta data from a previous read operation, or nullptr to clear.

The purpose of this method is not to preset the base data property list of the read data but to provide access to meta data of previous read operations that may be beneficial for the new read operation.

A typical use case occurs when reading files from an MITK scene file in which case base data properties are already provided in addition to the actual data file. If such a data file references other files relative to its original location on the filesystem, the original location can be retrieved from the base data properties. In this scenario, GetInputLocation() would return a path within a temporary directory in which the scene file has been extracted. This is not the intended base path for searching referenced external data files.

Implemented in mitk::AbstractFileReader.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~IFileReader() [1/2]

◆ ~IFileReader() [2/2]

Member Function Documentation

◆ GetInputLocation() [1/2]

◆ GetInputLocation() [2/2]

◆ GetInputStream() [1/2]

◆ GetInputStream() [2/2]

◆ GetProperties()

◆ GetReadFiles()

◆ Read() [1/4]

◆ Read() [2/4]

◆ Read() [3/4]

◆ Read() [4/4]

◆ SetInput() [1/4]

◆ SetInput() [2/4]

◆ SetInput() [3/4]

◆ SetInput() [4/4]

◆ SetProperties()