mitk::FileWriterRegistry Class Reference

Provides convenient access to mitk::IFileWriter instances and writing files from mitk::BaseData types. More...

#include <mitkFileWriterRegistry.h>

Public Types
typedef us::ServiceReference< IFileWriter >	WriterReference

Public Member Functions
	FileWriterRegistry ()
	Constructor. More...
	~FileWriterRegistry ()
	Destructor. Releases all acquired service objects. More...
IFileWriter *	GetWriter (const WriterReference &ref, us::ModuleContext *context=us::GetModuleContext())
	Get a writer instance from a service reference. More...
std::vector< IFileWriter * >	GetWriters (const BaseData *baseData, const std::string &mimeType, us::ModuleContext *context=us::GetModuleContext())
	Get all writer instances for the given BaseData and MIME type. More...
void	UngetWriter (IFileWriter *writer)
	Release a previously acquired writer instance. More...
void	UngetWriters (const std::vector< IFileWriter * > &writers)
	Release multiple previously acquired writer instances. More...

Static Public Member Functions
static std::vector< WriterReference >	GetReferences (const BaseData *baseData, us::ModuleContext *context=us::GetModuleContext())
	Get service references for writers that can handle the given BaseData. More...
static std::vector< WriterReference >	GetReferences (const BaseData *baseData, const std::string &mimeType, us::ModuleContext *context=us::GetModuleContext())
	Get service references for writers that can handle the given BaseData and MIME type. More...

Detailed Description

Provides convenient access to mitk::IFileWriter instances and writing files from mitk::BaseData types.

Note

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

See also

IFileWriter

Definition at line 43 of file mitkFileWriterRegistry.h.

Member Typedef Documentation

WriterReference

typedef us::ServiceReference<IFileWriter> mitk::FileWriterRegistry::WriterReference

Definition at line 46 of file mitkFileWriterRegistry.h.

Constructor & Destructor Documentation

FileWriterRegistry()

mitk::FileWriterRegistry::FileWriterRegistry

(

)

Constructor.

~FileWriterRegistry()

mitk::FileWriterRegistry::~FileWriterRegistry

(

)

Destructor. Releases all acquired service objects.

Member Function Documentation

GetReferences() [1/2]

static std::vector<WriterReference> mitk::FileWriterRegistry::GetReferences ( const BaseData *  baseData, const std::string &  mimeType, us::ModuleContext *  context = us::GetModuleContext()  )

static

Get service references for writers that can handle the given BaseData and MIME type.

Parameters

baseData	The data object for which to find compatible writers.
mimeType	The MIME type to filter by.
context	The module context to use for service lookup.

Returns

A vector of matching writer service references.

GetReferences() [2/2]

static std::vector<WriterReference> mitk::FileWriterRegistry::GetReferences ( const BaseData *  baseData, us::ModuleContext *  context = us::GetModuleContext()  )

static

Get service references for writers that can handle the given BaseData.

Parameters

baseData	The data object for which to find compatible writers.
context	The module context to use for service lookup.

Returns

A vector of matching writer service references.

GetWriter()

IFileWriter* mitk::FileWriterRegistry::GetWriter	(	const WriterReference &	ref,
		us::ModuleContext *	context = us::GetModuleContext()
	)

Get a writer instance from a service reference.

Parameters

ref	The writer service reference.
context	The module context to use for service lookup.

Returns

A pointer to the writer instance, or nullptr if the reference is invalid.

GetWriters()

std::vector<IFileWriter *> mitk::FileWriterRegistry::GetWriters	(	const BaseData *	baseData,
		const std::string &	mimeType,
		us::ModuleContext *	context = us::GetModuleContext()
	)

Get all writer instances for the given BaseData and MIME type.

Parameters

baseData	The data object for which to find compatible writers.
mimeType	The MIME type to filter by.
context	The module context to use for service lookup.

Returns

A vector of writer pointers sorted by service ranking.

UngetWriter()

void mitk::FileWriterRegistry::UngetWriter

(

IFileWriter *

writer

)

Release a previously acquired writer instance.

Parameters

writer

The writer to release.

UngetWriters()

void mitk::FileWriterRegistry::UngetWriters

(

const std::vector< IFileWriter * > &

writers

)

Release multiple previously acquired writer instances.

Parameters

writers

The vector of writers to release.

---

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

• mitkFileWriterRegistry.h