Abstract base class for implementing a combined file reader and writer. More...

#include <mitkAbstractFileIO.h>

Inheritance diagram for mitk::AbstractFileIO:

[legend]

Collaboration diagram for mitk::AbstractFileIO:

[legend]

Public Member Functions
Options	GetReaderOptions () const
	Get the reader-specific options. More...

us::Any	GetReaderOption (const std::string &name) const
	Get the value of a specific reader option. More...

void	SetReaderOptions (const Options &options)
	Set multiple reader options at once. More...

void	SetReaderOption (const std::string &name, const us::Any &value)
	Set a single reader option. More...

Options	GetWriterOptions () const
	Get the writer-specific options. More...

us::Any	GetWriterOption (const std::string &name) const
	Get the value of a specific writer option. More...

void	SetWriterOptions (const Options &options)
	Set multiple writer options at once. More...

void	SetWriterOption (const std::string &name, const us::Any &value)
	Set a single writer option. More...

ConfidenceLevel	GetReaderConfidenceLevel () const override
	Get the reader confidence level for the current input. More...

ConfidenceLevel	GetWriterConfidenceLevel () const override
	Get the writer confidence level for the current input data. More...

std::pair< us::ServiceRegistration< IFileReader >, us::ServiceRegistration< IFileWriter > >	RegisterService (us::ModuleContext *context=us::GetModuleContext())
	Register both reader and writer as CppMicroServices services. More...

Public Member Functions inherited from mitk::AbstractFileIOReader
ConfidenceLevel	GetConfidenceLevel () const override
	Get the confidence level of this reader or writer for the current input. More...

Public Member Functions inherited from mitk::AbstractFileReader
void	SetInput (const std::string &location) override
	Set the input file path, clearing any previously set input stream. More...

void	SetInput (const std::string &location, std::istream *is) override
	Set an input stream and associated location label. More...

std::string	GetInputLocation () const override
	Get the current input location. More...

std::istream *	GetInputStream () const override
	Get the current input stream. More...

MimeType	GetRegisteredMimeType () const
	Get the mime-type that was registered for this reader. More...

std::vector< itk::SmartPointer< BaseData > >	Read () override
	Read data and create a list of BaseData objects. More...

DataStorage::SetOfObjects::Pointer	Read (mitk::DataStorage &ds) override
	Read data and add it to the given DataStorage. More...

ConfidenceLevel	GetConfidenceLevel () const override
	Determine confidence for reading the current input. More...

Options	GetOptions () const override
	Get the current option values. More...

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

void	SetOptions (const Options &options) override
	Set multiple options at once. More...

void	SetOption (const std::string &name, const us::Any &value) override
	Set a single option value. More...

void	AddProgressCallback (const ProgressCallback &callback) override
	Register a progress callback. More...

void	RemoveProgressCallback (const ProgressCallback &callback) override
	Remove a previously registered progress callback. More...

us::ServiceRegistration< IFileReader >	RegisterService (us::ModuleContext *context=us::GetModuleContext())
	Register this reader as a CppMicroServices service. More...

void	UnregisterService ()
	Unregister this reader from the CppMicroServices registry. More...

std::vector< std::string >	GetReadFiles () override
	Get the list of files consumed during the last Read() call. More...

void	SetProperties (const PropertyList *properties) override
	Set base data properties as a source of meta data for reading. More...

Public Member Functions inherited from mitk::IFileReader
	~IFileReader () override

virtual	~IFileReader ()

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

Public Member Functions inherited from mitk::AbstractFileIOWriter
ConfidenceLevel	GetConfidenceLevel () const override
	Get the confidence level of this reader or writer for the current input. More...

Public Member Functions inherited from mitk::AbstractFileWriter
void	SetInput (const BaseData *data) override
	Set the input data for writing. More...

const BaseData *	GetInput () const override
	Get the input data. More...

void	SetOutputLocation (const std::string &location) override
	Set the output file-system path, clearing any output stream. More...

std::string	GetOutputLocation () const override
	Get the current output location. More...

void	SetOutputStream (const std::string &location, std::ostream *os) override
	Set an output stream and associated location label. More...

std::ostream *	GetOutputStream () const override
	Get the current output stream. More...

void	Write () override=0
	Write the base data to the specified location or output stream. More...

ConfidenceLevel	GetConfidenceLevel () const override
	Determine confidence for writing the current input data. More...

MimeType	GetRegisteredMimeType () const
	Get the MIME type that was registered for this writer. More...

Options	GetOptions () const override
	Get the current option values. More...

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

void	SetOptions (const Options &options) override
	Set multiple options at once. More...

void	SetOption (const std::string &name, const us::Any &value) override
	Set a single option value. More...

void	AddProgressCallback (const ProgressCallback &callback) override
	Register a progress callback. More...

void	RemoveProgressCallback (const ProgressCallback &callback) override
	Remove a previously registered progress callback. More...

us::ServiceRegistration< IFileWriter >	RegisterService (us::ModuleContext *context=us::GetModuleContext())
	Register this writer as a CppMicroServices service. More...

void	UnregisterService ()
	Unregister this writer from the CppMicroServices registry. More...

Public Member Functions inherited from mitk::IFileWriter
	~IFileWriter () override

Protected Member Functions
	AbstractFileIO (const AbstractFileIO &other)
	Copy constructor. More...

	AbstractFileIO (const std::string &baseDataType)
	Construct with a BaseData type name only. More...

	AbstractFileIO (const std::string &baseDataType, const CustomMimeType &mimeType, const std::string &description)
	Construct with a BaseData type, MIME type, and description. More...

void	SetMimeType (const CustomMimeType &mimeType)
	Set the shared MIME type for both reader and writer. More...

const CustomMimeType *	GetMimeType () const
	Get the shared MIME type. More...

void	SetReaderDescription (const std::string &description)
	Set the description for the reader part. More...

std::string	GetReaderDescription () const
	Get the description of the reader part. More...

void	SetWriterDescription (const std::string &description)
	Set the description for the writer part. More...

std::string	GetWriterDescription () const
	Get the description of the writer part. More...

void	SetDefaultReaderOptions (const Options &defaultOptions)
	Set default options for the reader part. More...

Options	GetDefaultReaderOptions () const
	Get the default options for the reader part. More...

void	SetDefaultWriterOptions (const Options &defaultOptions)
	Set default options for the writer part. More...

Options	GetDefaultWriterOptions () const
	Get the default options for the writer part. More...

void	SetReaderRanking (int ranking)
	Set the service ranking for the reader part. More...

int	GetReaderRanking () const
	Get the service ranking for the reader part. More...

void	SetWriterRanking (int ranking)
	Set the service ranking for the writer part. More...

int	GetWriterRanking () const
	Get the service ranking for the writer part. More...

Protected Member Functions inherited from mitk::AbstractFileIOReader
	AbstractFileIOReader ()

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

Protected Member Functions inherited from mitk::AbstractFileReader
	AbstractFileReader ()
	Default constructor. More...

	~AbstractFileReader () override

	AbstractFileReader (const AbstractFileReader &other)
	Copy constructor. More...

	AbstractFileReader (const CustomMimeType &mimeType, const std::string &description)
	Associate this reader instance with the given MIME type. More...

virtual std::vector< itk::SmartPointer< BaseData > >	DoRead ()=0
	Perform the actual reading operation. More...

virtual us::ServiceProperties	GetServiceProperties () const
	Get the service properties for registration. More...

virtual us::ServiceRegistration< CustomMimeType >	RegisterMimeType (us::ModuleContext *context)
	Register a new CustomMimeType service object. More...

void	SetMimeType (const CustomMimeType &mimeType)
	Set the MIME type this reader can handle. More...

const CustomMimeType *	GetMimeType () const
	Get the MIME type this reader can handle. More...

void	SetMimeTypePrefix (const std::string &prefix)
	Set the prefix used for auto-generated MIME type names. More...

std::string	GetMimeTypePrefix () const
	Get the current MIME type name prefix. More...

void	SetDescription (const std::string &description)
	Set the human-readable description of this reader. More...

std::string	GetDescription () const
	Get the human-readable description of this reader. More...

void	SetDefaultOptions (const Options &defaultOptions)
	Set the default options for this reader. More...

Options	GetDefaultOptions () const
	Get the default options for this reader. More...

void	SetRanking (int ranking)
	Set the service ranking for this file reader. More...

int	GetRanking () const
	Get the service ranking for this file reader. More...

std::string	GetLocalFileName () const
	Get a local file name for reading. More...

virtual void	SetDefaultDataNodeProperties (DataNode *node, const std::string &filePath)
	Set default properties on a DataNode after reading. More...

const PropertyList *	GetProperties () const override
	Get the properties set via SetProperties(). More...

Protected Member Functions inherited from mitk::AbstractFileIOWriter
	AbstractFileIOWriter (const std::string &baseDataType)

	AbstractFileIOWriter (const std::string &baseDataType, const CustomMimeType &mimeType, const std::string &description)

Protected Member Functions inherited from mitk::AbstractFileWriter
	~AbstractFileWriter () override

	AbstractFileWriter (const AbstractFileWriter &other)
	Copy constructor. More...

	AbstractFileWriter (const std::string &baseDataType)
	Construct a writer for the given BaseData type name. More...

	AbstractFileWriter (const std::string &baseDataType, const CustomMimeType &mimeType, const std::string &description)
	Construct a writer for the given BaseData type, MIME type, and description. More...

virtual us::ServiceProperties	GetServiceProperties () const
	Get the service properties for registration. More...

virtual us::ServiceRegistration< CustomMimeType >	RegisterMimeType (us::ModuleContext *context)
	Register a new CustomMimeType service object. More...

void	SetMimeType (const CustomMimeType &mimeType)
	Set the MIME type this writer can handle. More...

const CustomMimeType *	GetMimeType () const
	Get the MIME type this writer can handle. More...

void	SetMimeTypePrefix (const std::string &prefix)
	Set the prefix used for auto-generated MIME type names. More...

std::string	GetMimeTypePrefix () const
	Get the current MIME type name prefix. More...

void	SetDescription (const std::string &description)
	Set a human-readable description of this writer. More...

std::string	GetDescription () const
	Get the human-readable description of this writer. More...

void	SetDefaultOptions (const Options &defaultOptions)
	Set the default options for this writer. More...

Options	GetDefaultOptions () const
	Get the default options for this writer. More...

void	SetRanking (int ranking)
	Set the service ranking for this file writer. More...

int	GetRanking () const
	Get the service ranking for this file writer. More...

void	SetBaseDataType (const std::string &baseDataType)
	Set the name of the mitk::BaseData sub-class this writer supports. More...

virtual std::string	GetBaseDataType () const
	Get the name of the mitk::BaseData sub-class this writer supports. More...

void	ValidateOutputLocation () const
	Validate the output location or stream. 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...

Static Public Member Functions inherited from mitk::IFileWriter
static std::string	PROP_BASEDATA_TYPE ()
	Service property name for the supported mitk::BaseData sub-class. More...

Protected Attributes inherited from mitk::AbstractFileReader
std::vector< std::string >	m_ReadFiles
	List of files consumed during the last Read() call. Must be filled by DoRead(). More...

Detailed Description

Abstract base class for implementing a combined file reader and writer.

AbstractFileIO is a convenience class that inherits from both AbstractFileReader and AbstractFileWriter (via intermediate adapters). It shares a single MIME type between both reader and writer registrations and provides unified option management. Subclasses must implement DoRead(), Write(), and IOClone().

See also: AbstractFileReader; AbstractFileWriter; IFileReader; IFileWriter

Definition at line 80 of file mitkAbstractFileIO.h.

Constructor & Destructor Documentation

◆ AbstractFileIO() [1/3]

mitk::AbstractFileIO::AbstractFileIO ( const AbstractFileIO & other )

protected

Copy constructor.

Parameters

[in] other The AbstractFileIO to copy from.

◆ AbstractFileIO() [2/3]

mitk::AbstractFileIO::AbstractFileIO ( const std::string & baseDataType )

protected

Construct with a BaseData type name only.

Parameters

[in] baseDataType The class name of the supported BaseData sub-class.

◆ AbstractFileIO() [3/3]

mitk::AbstractFileIO::AbstractFileIO	(	const std::string &	baseDataType,
		const CustomMimeType &	mimeType,
		const std::string &	description
	)

explicitprotected

Construct with a BaseData type, MIME type, and description.

If the given MIME type has nothing but its name set, the matching MIME type is looked up in the service registry.

Parameters

[in]	baseDataType	The class name of the supported BaseData sub-class.
[in]	mimeType	The MIME type this reader/writer handles.
[in]	description	A human-readable description.

Exceptions

std::invalid_argument if mimeType is empty.

See also: RegisterService()

Member Function Documentation

◆ GetDefaultReaderOptions()

Options mitk::AbstractFileIO::GetDefaultReaderOptions ( ) const

protected

Get the default options for the reader part.

Returns: A map of option names to default values.

◆ GetDefaultWriterOptions()

Options mitk::AbstractFileIO::GetDefaultWriterOptions ( ) const

protected

Get the default options for the writer part.

Returns: A map of option names to default values.

◆ GetMimeType()

const CustomMimeType* mitk::AbstractFileIO::GetMimeType ( ) const

protected

Get the shared MIME type.

Returns: Pointer to the reader's CustomMimeType. Logs a warning if the reader and writer MIME types differ.

◆ GetReaderConfidenceLevel()

ConfidenceLevel mitk::AbstractFileIO::GetReaderConfidenceLevel ( ) const

overridevirtual

Get the reader confidence level for the current input.

Returns: The confidence level of the reader part.

Reimplemented from mitk::AbstractFileIOReader.

Reimplemented in mitk::PlanarFigureIO, mitk::MultiLabelSegmentationIO, mitk::DICOMSegmentationIO, mitk::MAPRegistrationWrapperIO, mitk::DICOMPMIO, mitk::SurfaceVtkXmlIO, mitk::SurfaceVtkLegacyIO, mitk::ImageVtkXmlIO, mitk::ImageVtkLegacyIO, and mitk::ItkImageIO.

◆ GetReaderDescription()

std::string mitk::AbstractFileIO::GetReaderDescription ( ) const

protected

Get the description of the reader part.

Returns: The reader description string.

◆ GetReaderOption()

us::Any mitk::AbstractFileIO::GetReaderOption ( const std::string & name ) const

Get the value of a specific reader option.

Parameters

[in] name The option name.

Returns: The option value.

◆ GetReaderOptions()

Options mitk::AbstractFileIO::GetReaderOptions ( ) const

Get the reader-specific options.

Returns: A map of reader option names to their current values.

◆ GetReaderRanking()

int mitk::AbstractFileIO::GetReaderRanking ( ) const

protected

Get the service ranking for the reader part.

Returns: The ranking value.

◆ GetWriterConfidenceLevel()

ConfidenceLevel mitk::AbstractFileIO::GetWriterConfidenceLevel ( ) const

overridevirtual

Get the writer confidence level for the current input data.

Returns: The confidence level of the writer part.

Reimplemented from mitk::AbstractFileIOWriter.

Reimplemented in mitk::PlanarFigureIO, mitk::MultiLabelSegmentationIO, mitk::DICOMSegmentationIO, mitk::MAPRegistrationWrapperIO, mitk::DICOMPMIO, mitk::SurfaceVtkIO, mitk::ImageVtkXmlIO, mitk::ImageVtkLegacyIO, and mitk::ItkImageIO.

◆ GetWriterDescription()

std::string mitk::AbstractFileIO::GetWriterDescription ( ) const

protected

Get the description of the writer part.

Returns: The writer description string.

◆ GetWriterOption()

us::Any mitk::AbstractFileIO::GetWriterOption ( const std::string & name ) const

Get the value of a specific writer option.

Parameters

[in] name The option name.

Returns: The option value.

◆ GetWriterOptions()

Options mitk::AbstractFileIO::GetWriterOptions ( ) const

Get the writer-specific options.

Returns: A map of writer option names to their current values.

◆ GetWriterRanking()

int mitk::AbstractFileIO::GetWriterRanking ( ) const

protected

Get the service ranking for the writer part.

Returns: The ranking value.

◆ RegisterService()

std::pair<us::ServiceRegistration<IFileReader>, us::ServiceRegistration<IFileWriter> > mitk::AbstractFileIO::RegisterService ( us::ModuleContext * context = us::GetModuleContext() )

Register both reader and writer as CppMicroServices services.

The writer's MIME type is automatically synchronized with the reader's MIME type if not explicitly set.

Parameters

[in] context The module context for service registration. Defaults to the current module context.

Returns: A pair of service registrations for the reader and writer.

◆ SetDefaultReaderOptions()

void mitk::AbstractFileIO::SetDefaultReaderOptions ( const Options & defaultOptions )

protected

Set default options for the reader part.

Parameters

[in] defaultOptions A map of option names to default values.

◆ SetDefaultWriterOptions()

void mitk::AbstractFileIO::SetDefaultWriterOptions ( const Options & defaultOptions )

protected

Set default options for the writer part.

Parameters

[in] defaultOptions A map of option names to default values.

◆ SetMimeType()

void mitk::AbstractFileIO::SetMimeType ( const CustomMimeType & mimeType )

protected

Set the shared MIME type for both reader and writer.

Parameters

[in] mimeType The CustomMimeType to set on both sides.

◆ SetReaderDescription()

void mitk::AbstractFileIO::SetReaderDescription ( const std::string & description )

protected

Set the description for the reader part.

Parameters

[in] description The reader description string.

◆ SetReaderOption()

void mitk::AbstractFileIO::SetReaderOption	(	const std::string &	name,
		const us::Any &	value
	)

Set a single reader option.

Parameters

[in]	name	The option name.
[in]	value	The new option value.

◆ SetReaderOptions()

void mitk::AbstractFileIO::SetReaderOptions ( const Options & options )

Set multiple reader options at once.

Parameters

[in] options A map of reader option names to values.

◆ SetReaderRanking()

void mitk::AbstractFileIO::SetReaderRanking ( int ranking )

protected

Set the service ranking for the reader part.

Parameters

[in] ranking The ranking value. Default is zero.

Higher ranking values cause this reader to be preferred over other readers for the same MIME type.

◆ SetWriterDescription()

void mitk::AbstractFileIO::SetWriterDescription ( const std::string & description )

protected

Set the description for the writer part.

Parameters

[in] description The writer description string.

◆ SetWriterOption()

void mitk::AbstractFileIO::SetWriterOption	(	const std::string &	name,
		const us::Any &	value
	)

Set a single writer option.

Parameters

[in]	name	The option name.
[in]	value	The new option value.

◆ SetWriterOptions()

void mitk::AbstractFileIO::SetWriterOptions ( const Options & options )

Set multiple writer options at once.

Parameters

[in] options A map of writer option names to values.

◆ SetWriterRanking()

void mitk::AbstractFileIO::SetWriterRanking ( int ranking )

protected

Set the service ranking for the writer part.

Parameters

[in] ranking The ranking value. Default is zero.

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

mitkAbstractFileIO.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AbstractFileIO() [1/3]

◆ AbstractFileIO() [2/3]

◆ AbstractFileIO() [3/3]

Member Function Documentation

◆ GetDefaultReaderOptions()

◆ GetDefaultWriterOptions()

◆ GetMimeType()

◆ GetReaderConfidenceLevel()

◆ GetReaderDescription()

◆ GetReaderOption()

◆ GetReaderOptions()

◆ GetReaderRanking()

◆ GetWriterConfidenceLevel()

◆ GetWriterDescription()

◆ GetWriterOption()

◆ GetWriterOptions()

◆ GetWriterRanking()

◆ RegisterService()

◆ SetDefaultReaderOptions()

◆ SetDefaultWriterOptions()

◆ SetMimeType()

◆ SetReaderDescription()

◆ SetReaderOption()

◆ SetReaderOptions()

◆ SetReaderRanking()

◆ SetWriterDescription()

◆ SetWriterOption()

◆ SetWriterOptions()

◆ SetWriterRanking()