Medical Imaging Interaction Toolkit  2021.02.99-c051ab3b
Medical Imaging Interaction Toolkit
QmitkDataStorageInspectorProviderBase< TInspector > Class Template Reference

Base class for DataStorage inspector provider. More...

#include <QmitkDataStorageInspectorProviderBase.h>

Inheritance diagram for QmitkDataStorageInspectorProviderBase< TInspector >:
Collaboration diagram for QmitkDataStorageInspectorProviderBase< TInspector >:

Public Types

using InspectorIDType = mitk::IDataStorageInspectorProvider::InspectorIDType
 
- Public Types inherited from mitk::IDataStorageInspectorProvider
using InspectorIDType = std::string
 

Public Member Functions

QmitkAbstractDataStorageInspectorCreateInspector () const override
 returns an inspector instance represented by the provider. More...
 
InspectorIDType GetInspectorID () const override
 
std::string GetInspectorDisplayName () const override
 
std::string GetInspectorDescription () const override
 
QIcon GetInspectorIcon () const override
 
us::ServiceRegistration< mitk::IDataStorageInspectorProviderRegisterService (us::ModuleContext *context=us::GetModuleContext())
 
void UnregisterService ()
 
 QmitkDataStorageInspectorProviderBase (const std::string &id)
 
 QmitkDataStorageInspectorProviderBase (const std::string &id, const std::string &displayName, const std::string &desc="", const std::string &pathToIconSVG="")
 
 ~QmitkDataStorageInspectorProviderBase () override
 
- Public Member Functions inherited from mitk::IDataStorageInspectorProvider
virtual ~IDataStorageInspectorProvider ()
 

Protected Member Functions

 QmitkDataStorageInspectorProviderBase (const QmitkDataStorageInspectorProviderBase &other)
 
QmitkDataStorageInspectorProviderBaseoperator= (const QmitkDataStorageInspectorProviderBase &other)=delete
 
virtual us::ServiceProperties GetServiceProperties () const
 
void SetRanking (int ranking)
 Set the service ranking for this file reader. More...
 
int GetRanking () const
 

Additional Inherited Members

- Static Public Member Functions inherited from mitk::IDataStorageInspectorProvider
static std::string PROP_INSPECTOR_ID ()
 Service property name for the inspector ID. More...
 

Detailed Description

template<class TInspector>
class QmitkDataStorageInspectorProviderBase< TInspector >

Base class for DataStorage inspector provider.

This class is the default implementation for a inspector provider. You can template it with the respective inspector class to directly use it.

Definition at line 34 of file QmitkDataStorageInspectorProviderBase.h.

Member Typedef Documentation

◆ InspectorIDType

Constructor & Destructor Documentation

◆ QmitkDataStorageInspectorProviderBase() [1/3]

template<class TInspector >
QmitkDataStorageInspectorProviderBase< TInspector >::QmitkDataStorageInspectorProviderBase ( const std::string &  id)

◆ QmitkDataStorageInspectorProviderBase() [2/3]

template<class TInspector >
QmitkDataStorageInspectorProviderBase< TInspector >::QmitkDataStorageInspectorProviderBase ( const std::string &  id,
const std::string &  displayName,
const std::string &  desc = "",
const std::string &  pathToIconSVG = "" 
)

◆ ~QmitkDataStorageInspectorProviderBase()

template<class TInspector >
QmitkDataStorageInspectorProviderBase< TInspector >::~QmitkDataStorageInspectorProviderBase ( )
override

◆ QmitkDataStorageInspectorProviderBase() [3/3]

template<class TInspector >
QmitkDataStorageInspectorProviderBase< TInspector >::QmitkDataStorageInspectorProviderBase ( const QmitkDataStorageInspectorProviderBase< TInspector > &  other)
protected

Member Function Documentation

◆ CreateInspector()

template<class TInspector >
QmitkAbstractDataStorageInspector* QmitkDataStorageInspectorProviderBase< TInspector >::CreateInspector ( ) const
overridevirtual

returns an inspector instance represented by the provider.

Implements mitk::IDataStorageInspectorProvider.

◆ GetInspectorDescription()

template<class TInspector >
std::string QmitkDataStorageInspectorProviderBase< TInspector >::GetInspectorDescription ( ) const
overridevirtual

Returns a description of the inspector type provided.

Implements mitk::IDataStorageInspectorProvider.

◆ GetInspectorDisplayName()

template<class TInspector >
std::string QmitkDataStorageInspectorProviderBase< TInspector >::GetInspectorDisplayName ( ) const
overridevirtual

Return the display name (e.g. used in the UI) for the inspector type provided.

Implements mitk::IDataStorageInspectorProvider.

◆ GetInspectorIcon()

template<class TInspector >
QIcon QmitkDataStorageInspectorProviderBase< TInspector >::GetInspectorIcon ( ) const
overridevirtual

Returns the svg data of the icon of the inspector. Empty array indicates that no icon is defined.

Remarks
It is passed as svg file content and not as icon directly to allow later styling

Implements mitk::IDataStorageInspectorProvider.

◆ GetInspectorID()

template<class TInspector >
InspectorIDType QmitkDataStorageInspectorProviderBase< TInspector >::GetInspectorID ( ) const
overridevirtual

Return the uniqe ID for the inspector type provided.

Implements mitk::IDataStorageInspectorProvider.

◆ GetRanking()

template<class TInspector >
int QmitkDataStorageInspectorProviderBase< TInspector >::GetRanking ( ) const
protected

◆ GetServiceProperties()

template<class TInspector >
virtual us::ServiceProperties QmitkDataStorageInspectorProviderBase< TInspector >::GetServiceProperties ( ) const
protectedvirtual

◆ operator=()

template<class TInspector >
QmitkDataStorageInspectorProviderBase& QmitkDataStorageInspectorProviderBase< TInspector >::operator= ( const QmitkDataStorageInspectorProviderBase< TInspector > &  other)
protecteddelete

◆ RegisterService()

template<class TInspector >
us::ServiceRegistration<mitk::IDataStorageInspectorProvider> QmitkDataStorageInspectorProviderBase< TInspector >::RegisterService ( us::ModuleContext *  context = us::GetModuleContext())

◆ SetRanking()

template<class TInspector >
void QmitkDataStorageInspectorProviderBase< TInspector >::SetRanking ( int  ranking)
protected

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 provider to use if several equivalent providers have been found. It may be used to replace a default provider from MITK in your own project.

◆ UnregisterService()

template<class TInspector >
void QmitkDataStorageInspectorProviderBase< TInspector >::UnregisterService ( )

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