Common base class for file reader and writer implementations. More...

#include <mitkFileReaderWriterBase.h>

Collaboration diagram for mitk::FileReaderWriterBase:

[legend]

Public Types
typedef std::map< std::string, us::Any >	Options
	Map of option names to their values. More...

typedef mitk::MessageAbstractDelegate1< float >	ProgressCallback
	Delegate type for progress notification callbacks. More...

Public Member Functions
	FileReaderWriterBase ()

virtual	~FileReaderWriterBase ()

Options	GetOptions () const
	Get all current options merged with defaults. More...

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

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

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

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

Options	GetDefaultOptions () const
	Get the default options. More...

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

int	GetRanking () const
	Get the current service ranking. More...

void	SetMimeType (const CustomMimeType &mimeType)
	Set the MIME type for this reader/writer. More...

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

CustomMimeType *	GetMimeType ()
	Get the associated MIME type (mutable). More...

MimeType	GetRegisteredMimeType () const
	Get the MIME type as registered with the service framework. More...

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

std::string	GetMimeTypePrefix () const
	Get the prefix used for auto-generated MIME type names. More...

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

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

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

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

us::ServiceRegistration< CustomMimeType >	RegisterMimeType (us::ModuleContext *context)
	Register the MIME type as a CppMicroServices service. More...

void	UnregisterMimeType ()
	Unregister a previously registered MIME type service. More...

Protected Member Functions
	FileReaderWriterBase (const FileReaderWriterBase &other)

Protected Attributes
std::string	m_Description

int	m_Ranking

std::string	m_MimeTypePrefix

Options	m_Options
	Options supported by this reader. Set sensible default values! More...

Options	m_DefaultOptions

Message1< float >	m_ProgressMessage

std::unique_ptr< CustomMimeType >	m_CustomMimeType

us::ServiceRegistration< CustomMimeType >	m_MimeTypeReg

Detailed Description

Common base class for file reader and writer implementations.

Provides shared functionality for file I/O classes, including option management, MIME type handling, service ranking, progress callbacks, and CppMicroServices MIME type registration. This class is used as a common implementation detail by AbstractFileReader and AbstractFileWriter.

See also: AbstractFileReader; AbstractFileWriter; CustomMimeType

Definition at line 39 of file mitkFileReaderWriterBase.h.

Member Typedef Documentation

◆ Options

typedef std::map<std::string, us::Any> mitk::FileReaderWriterBase::Options

Map of option names to their values.

Definition at line 43 of file mitkFileReaderWriterBase.h.

◆ ProgressCallback

typedef mitk::MessageAbstractDelegate1<float> mitk::FileReaderWriterBase::ProgressCallback

Delegate type for progress notification callbacks.

Definition at line 46 of file mitkFileReaderWriterBase.h.

Constructor & Destructor Documentation

◆ FileReaderWriterBase() [1/2]

mitk::FileReaderWriterBase::FileReaderWriterBase ( )

◆ ~FileReaderWriterBase()

virtual mitk::FileReaderWriterBase::~FileReaderWriterBase ( )

virtual

◆ FileReaderWriterBase() [2/2]

mitk::FileReaderWriterBase::FileReaderWriterBase ( const FileReaderWriterBase & other )

protected

Member Function Documentation

◆ AddProgressCallback()

void mitk::FileReaderWriterBase::AddProgressCallback ( const ProgressCallback & callback )

Register a callback for progress notifications.

Parameters

[in] callback The callback delegate to add.

◆ GetDefaultOptions()

Options mitk::FileReaderWriterBase::GetDefaultOptions ( ) const

Get the default options.

Returns: A map of option names to default values.

◆ GetDescription()

std::string mitk::FileReaderWriterBase::GetDescription ( ) const

Get the human-readable description of this reader/writer.

Returns: The description string.

◆ GetMimeType() [1/2]

CustomMimeType* mitk::FileReaderWriterBase::GetMimeType ( )

Get the associated MIME type (mutable).

Returns: Pointer to the CustomMimeType, or nullptr if not set.

◆ GetMimeType() [2/2]

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

Get the associated MIME type (const).

Returns: Pointer to the CustomMimeType, or nullptr if not set.

◆ GetMimeTypePrefix()

std::string mitk::FileReaderWriterBase::GetMimeTypePrefix ( ) const

Get the prefix used for auto-generated MIME type names.

Returns: The MIME type name prefix.

◆ GetOption()

us::Any mitk::FileReaderWriterBase::GetOption ( const std::string & name ) const

Get the value of a specific option.

Looks up the option first in user-set options, then in defaults.

Parameters

[in] name The option name.

Returns: The option value, or an empty us::Any if not found.

◆ GetOptions()

Options mitk::FileReaderWriterBase::GetOptions ( ) const

Get all current options merged with defaults.

User-set options override default options. Options not explicitly set fall back to their default values.

Returns: A map of all option names to their current or default values.

◆ GetRanking()

int mitk::FileReaderWriterBase::GetRanking ( ) const

Get the current service ranking.

Returns: The ranking value.

◆ GetRegisteredMimeType()

MimeType mitk::FileReaderWriterBase::GetRegisteredMimeType ( ) const

Get the MIME type as registered with the service framework.

If the MIME type has been registered, returns a MimeType object with ranking and service ID. Otherwise, looks up the MIME type by name in the service registry.

Returns: The registered MimeType, or an invalid MimeType if not found.

◆ RegisterMimeType()

us::ServiceRegistration<CustomMimeType> mitk::FileReaderWriterBase::RegisterMimeType ( us::ModuleContext * context )

Register the MIME type as a CppMicroServices service.

If the MIME type name is empty, a synthetic name is generated from the prefix and the first file extension.

Parameters

[in] context The module context for service registration.

Returns: The service registration object.

Exceptions

std::invalid_argument if context is nullptr.

◆ RemoveProgressCallback()

void mitk::FileReaderWriterBase::RemoveProgressCallback ( const ProgressCallback & callback )

Remove a previously registered progress callback.

Parameters

[in] callback The callback delegate to remove.

◆ SetDefaultOptions()

void mitk::FileReaderWriterBase::SetDefaultOptions ( const Options & defaultOptions )

Set the default options.

Parameters

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

◆ SetDescription()

void mitk::FileReaderWriterBase::SetDescription ( const std::string & description )

Set a human-readable description of this reader/writer.

Parameters

[in] description The description string.

◆ SetMimeType()

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

Set the MIME type for this reader/writer.

Parameters

[in] mimeType The CustomMimeType to associate.

◆ SetMimeTypePrefix()

void mitk::FileReaderWriterBase::SetMimeTypePrefix ( const std::string & prefix )

Set the prefix used for auto-generated MIME type names.

Parameters

[in] prefix The MIME type name prefix.

◆ SetOption()

void mitk::FileReaderWriterBase::SetOption	(	const std::string &	name,
		const us::Any &	value
	)

Set a single option value.

Only options known from the default options can be set. Unknown options produce a warning. Passing an empty us::Any resets the option to its default.

Parameters

[in]	name	The option name.
[in]	value	The new value, or empty to reset to default.

◆ SetOptions()

void mitk::FileReaderWriterBase::SetOptions ( const Options & options )

Set multiple options at once.

Each option is validated against the default options. Unknown options are ignored with a warning.

Parameters

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

◆ SetRanking()

void mitk::FileReaderWriterBase::SetRanking ( int ranking )

Set the service ranking for this file reader/writer.

Default is zero and should only be chosen differently for a reason. The ranking is used to determine which reader to use if several equivalent readers have been found. It may be used to replace a default reader from MITK in your own project. E.g. if you want to use your own reader for nrrd files instead of the default, implement it and give it a higher ranking than zero.

Parameters

[in] ranking The ranking value.

◆ UnregisterMimeType()

void mitk::FileReaderWriterBase::UnregisterMimeType ( )

Unregister a previously registered MIME type service.

Member Data Documentation

◆ m_CustomMimeType

std::unique_ptr<CustomMimeType> mitk::FileReaderWriterBase::m_CustomMimeType

protected

Definition at line 225 of file mitkFileReaderWriterBase.h.

◆ m_DefaultOptions

Options mitk::FileReaderWriterBase::m_DefaultOptions

protected

Definition at line 219 of file mitkFileReaderWriterBase.h.

◆ m_Description

std::string mitk::FileReaderWriterBase::m_Description

protected

Definition at line 207 of file mitkFileReaderWriterBase.h.

◆ m_MimeTypePrefix

std::string mitk::FileReaderWriterBase::m_MimeTypePrefix

protected

Definition at line 210 of file mitkFileReaderWriterBase.h.

◆ m_MimeTypeReg

us::ServiceRegistration<CustomMimeType> mitk::FileReaderWriterBase::m_MimeTypeReg

protected

Definition at line 226 of file mitkFileReaderWriterBase.h.

◆ m_Options

Options mitk::FileReaderWriterBase::m_Options

protected

Options supported by this reader. Set sensible default values!

Can be left empty if no special options are required.

Definition at line 217 of file mitkFileReaderWriterBase.h.

◆ m_ProgressMessage

Message1<float> mitk::FileReaderWriterBase::m_ProgressMessage

protected

Definition at line 223 of file mitkFileReaderWriterBase.h.

◆ m_Ranking

int mitk::FileReaderWriterBase::m_Ranking

protected

Definition at line 208 of file mitkFileReaderWriterBase.h.

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

mitkFileReaderWriterBase.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Options

◆ ProgressCallback

Constructor & Destructor Documentation

◆ FileReaderWriterBase() [1/2]

◆ ~FileReaderWriterBase()

◆ FileReaderWriterBase() [2/2]

Member Function Documentation

◆ AddProgressCallback()

◆ GetDefaultOptions()

◆ GetDescription()

◆ GetMimeType() [1/2]

◆ GetMimeType() [2/2]

◆ GetMimeTypePrefix()

◆ GetOption()

◆ GetOptions()

◆ GetRanking()

◆ GetRegisteredMimeType()

◆ RegisterMimeType()

◆ RemoveProgressCallback()

◆ SetDefaultOptions()

◆ SetDescription()

◆ SetMimeType()

◆ SetMimeTypePrefix()

◆ SetOption()

◆ SetOptions()

◆ SetRanking()

◆ UnregisterMimeType()

Member Data Documentation

◆ m_CustomMimeType

◆ m_DefaultOptions

◆ m_Description

◆ m_MimeTypePrefix

◆ m_MimeTypeReg

◆ m_Options

◆ m_ProgressMessage

◆ m_Ranking