Medical Imaging Interaction Toolkit  2021.10.99-1c4db16f
Medical Imaging Interaction Toolkit
mitk::FileReaderWriterBase Class Reference

#include <mitkFileReaderWriterBase.h>

Collaboration diagram for mitk::FileReaderWriterBase:

Public Types

typedef std::map< std::string, us::AnyOptions
 
typedef mitk::MessageAbstractDelegate1< float > ProgressCallback
 

Public Member Functions

 FileReaderWriterBase ()
 
virtual ~FileReaderWriterBase ()
 
Options GetOptions () const
 
us::Any GetOption (const std::string &name) const
 
void SetOptions (const Options &options)
 
void SetOption (const std::string &name, const us::Any &value)
 
void SetDefaultOptions (const Options &defaultOptions)
 
Options GetDefaultOptions () const
 
void SetRanking (int ranking)
 Set the service ranking for this file reader. More...
 
int GetRanking () const
 
void SetMimeType (const CustomMimeType &mimeType)
 
const CustomMimeTypeGetMimeType () const
 
CustomMimeTypeGetMimeType ()
 
MimeType GetRegisteredMimeType () const
 
void SetMimeTypePrefix (const std::string &prefix)
 
std::string GetMimeTypePrefix () const
 
void SetDescription (const std::string &description)
 
std::string GetDescription () const
 
void AddProgressCallback (const ProgressCallback &callback)
 
void RemoveProgressCallback (const ProgressCallback &callback)
 
us::ServiceRegistration< CustomMimeTypeRegisterMimeType (us::ModuleContext *context)
 
void UnregisterMimeType ()
 

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< CustomMimeTypem_CustomMimeType
 
us::ServiceRegistration< CustomMimeTypem_MimeTypeReg
 

Detailed Description

Definition at line 27 of file mitkFileReaderWriterBase.h.

Member Typedef Documentation

◆ Options

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

Definition at line 30 of file mitkFileReaderWriterBase.h.

◆ ProgressCallback

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)

◆ GetDefaultOptions()

Options mitk::FileReaderWriterBase::GetDefaultOptions ( ) const

◆ GetDescription()

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

◆ GetMimeType() [1/2]

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

◆ GetMimeType() [2/2]

CustomMimeType* mitk::FileReaderWriterBase::GetMimeType ( )

◆ GetMimeTypePrefix()

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

◆ GetOption()

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

◆ GetOptions()

Options mitk::FileReaderWriterBase::GetOptions ( ) const

◆ GetRanking()

int mitk::FileReaderWriterBase::GetRanking ( ) const

◆ GetRegisteredMimeType()

MimeType mitk::FileReaderWriterBase::GetRegisteredMimeType ( ) const

◆ RegisterMimeType()

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

◆ RemoveProgressCallback()

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

◆ SetDefaultOptions()

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

◆ SetDescription()

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

◆ SetMimeType()

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

◆ SetMimeTypePrefix()

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

◆ SetOption()

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

◆ SetOptions()

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

◆ SetRanking()

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

Set the service ranking for this file reader.

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.

◆ UnregisterMimeType()

void mitk::FileReaderWriterBase::UnregisterMimeType ( )

Member Data Documentation

◆ m_CustomMimeType

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

Definition at line 97 of file mitkFileReaderWriterBase.h.

◆ m_DefaultOptions

Options mitk::FileReaderWriterBase::m_DefaultOptions
protected

Definition at line 91 of file mitkFileReaderWriterBase.h.

◆ m_Description

std::string mitk::FileReaderWriterBase::m_Description
protected

Definition at line 79 of file mitkFileReaderWriterBase.h.

◆ m_MimeTypePrefix

std::string mitk::FileReaderWriterBase::m_MimeTypePrefix
protected

Definition at line 82 of file mitkFileReaderWriterBase.h.

◆ m_MimeTypeReg

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

Definition at line 98 of file mitkFileReaderWriterBase.h.

◆ m_Options

Options mitk::FileReaderWriterBase::m_Options
protected

Options supported by this reader. Set sensible default values!

Can be left emtpy if no special options are required.

Definition at line 89 of file mitkFileReaderWriterBase.h.

◆ m_ProgressMessage

Message1<float> mitk::FileReaderWriterBase::m_ProgressMessage
protected

Definition at line 95 of file mitkFileReaderWriterBase.h.

◆ m_Ranking

int mitk::FileReaderWriterBase::m_Ranking
protected

Definition at line 80 of file mitkFileReaderWriterBase.h.


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