mitk::PreferenceListReaderOptionsFunctor Struct Reference

Option callback functor with a preference list/ black list option selection strategy. More...

#include <mitkPreferenceListReaderOptionsFunctor.h>

Inheritance diagram for mitk::PreferenceListReaderOptionsFunctor:

Collaboration diagram for mitk::PreferenceListReaderOptionsFunctor:

Public Types
using	ListType = std::vector< std::string >

Public Member Functions
bool	operator() (IOUtil::LoadInfo &loadInfo) const override
	PreferenceListReaderOptionsFunctor ()
	PreferenceListReaderOptionsFunctor (const ListType &preference, const ListType &black)

Protected Attributes
ListType	m_PreferenceList
ListType	m_BlackList

Detailed Description

Option callback functor with a preference list/ black list option selection strategy.

This functor can be used if a option selection should be done without user interaction. Setting up the functor one can specify a preference and black lists of controller descriptions. Any controller description on the black list will be ignored and never selected. The first controller description found on the preference list will be selected. Any controller listed on the black list is always ignored. Even if it is also listed on the preference list. If no preference listed controller is available, the functor will use the pre selected reader. If no pre selected controller is available, the functor will use the first not black listed reader.

See also

IOUtil

Definition at line 42 of file mitkPreferenceListReaderOptionsFunctor.h.

Member Typedef Documentation

ListType

using mitk::PreferenceListReaderOptionsFunctor::ListType = std::vector<std::string>

Definition at line 44 of file mitkPreferenceListReaderOptionsFunctor.h.

Constructor & Destructor Documentation

PreferenceListReaderOptionsFunctor() [1/2]

mitk::PreferenceListReaderOptionsFunctor::PreferenceListReaderOptionsFunctor

(

)

Definition at line 15 of file mitkPreferenceListReaderOptionsFunctor.cpp.

PreferenceListReaderOptionsFunctor() [2/2]

mitk::PreferenceListReaderOptionsFunctor::PreferenceListReaderOptionsFunctor	(	const ListType &	preference,
		const ListType &	black
	)

Definition at line 20 of file mitkPreferenceListReaderOptionsFunctor.cpp.

Member Function Documentation

operator()()

bool mitk::PreferenceListReaderOptionsFunctor::operator() ( IOUtil::LoadInfo &  loadInfo ) const

overridevirtual

Implements mitk::IOUtil::ReaderOptionsFunctorBase.

Definition at line 25 of file mitkPreferenceListReaderOptionsFunctor.cpp.

References mitk::FileReaderSelector::Get(), mitk::FileReaderSelector::Item::GetDescription(), mitk::FileReaderSelector::GetSelected(), mitk::FileReaderSelector::GetSelectedId(), m_BlackList, m_PreferenceList, mitk::IOUtil::LoadInfo::m_ReaderSelector, MITK_DEBUG, mitkThrow, and mitk::FileReaderSelector::Select().

Member Data Documentation

m_BlackList

ListType mitk::PreferenceListReaderOptionsFunctor::m_BlackList

protected

Definition at line 53 of file mitkPreferenceListReaderOptionsFunctor.h.

Referenced by operator()().

m_PreferenceList

ListType mitk::PreferenceListReaderOptionsFunctor::m_PreferenceList

protected

Definition at line 52 of file mitkPreferenceListReaderOptionsFunctor.h.

Referenced by operator()().

---

The documentation for this struct was generated from the following files:

• mitkPreferenceListReaderOptionsFunctor.h
• mitkPreferenceListReaderOptionsFunctor.cpp