The reader service for the MITK example data type. More...

#include <mitkExampleDataStructureReaderService.h>

Inheritance diagram for mitk::ExampleDataStructureReaderService:

Collaboration diagram for mitk::ExampleDataStructureReaderService:

Public Types
typedef mitk::ExampleDataStructure	OutputType

Public Types inherited from mitk::IFileIO
enum	ConfidenceLevel { Unsupported, PartiallySupported, Supported }
	A confidence level describing the confidence of the reader or writer in handling the given data. More...

typedef std::map< std::string, us::Any >	Options
	Options for reading or writing data. More...

typedef mitk::MessageAbstractDelegate1< float >	ProgressCallback

Public Member Functions
	ExampleDataStructureReaderService (const ExampleDataStructureReaderService &other)

	ExampleDataStructureReaderService ()

virtual	~ExampleDataStructureReaderService ()

virtual std::vector< itk::SmartPointer< BaseData > >	Read () override
	Reads a path or stream and creates a list of BaseData objects. More...

Public Member Functions inherited from mitk::AbstractFileReader
virtual void	SetInput (const std::string &location) override
	Set the input location. More...

virtual void	SetInput (const std::string &location, std::istream *is) override
	Set an input stream to read from. More...

virtual std::string	GetInputLocation () const override
	Get the current input location. More...

virtual std::istream *	GetInputStream () const override
	Get the input stream. More...

MimeType	GetRegisteredMimeType () const

virtual DataStorage::SetOfObjects::Pointer	Read (mitk::DataStorage &ds) override
	Reads the specified file or input stream, loading its contents into the provided DataStorage. More...

virtual ConfidenceLevel	GetConfidenceLevel () const override
	The confidence level of the reader or writer implementation. More...

virtual Options	GetOptions () const override
	returns a list of the supported options More...

virtual us::Any	GetOption (const std::string &name) const override

virtual void	SetOptions (const Options &options) override

virtual void	SetOption (const std::string &name, const us::Any &value) override

virtual void	AddProgressCallback (const ProgressCallback &callback) override

virtual void	RemoveProgressCallback (const ProgressCallback &callback) override

us::ServiceRegistration< IFileReader >	RegisterService (us::ModuleContext *context=us::GetModuleContext())

void	UnregisterService ()

Public Member Functions inherited from mitk::IFileReader
virtual	~IFileReader ()

Public Member Functions inherited from mitk::IFileIO
virtual	~IFileIO ()

Additional Inherited Members
Static Public Member Functions inherited from mitk::IFileIO
static std::string	PROP_DESCRIPTION ()
	Service property name for a description. More...

static std::string	PROP_MIMETYPE ()
	Service property name for the mime-type associated with this file writer. More...

Protected Member Functions inherited from mitk::AbstractFileReader
	AbstractFileReader ()

	~AbstractFileReader ()

	AbstractFileReader (const AbstractFileReader &other)

	AbstractFileReader (const CustomMimeType &mimeType, const std::string &description)

virtual us::ServiceProperties	GetServiceProperties () const

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

void	SetMimeType (const CustomMimeType &mimeType)

const CustomMimeType *	GetMimeType () const

void	SetMimeTypePrefix (const std::string &prefix)

std::string	GetMimeTypePrefix () const

void	SetDescription (const std::string &description)

std::string	GetDescription () const

void	SetDefaultOptions (const Options &defaultOptions)

Options	GetDefaultOptions () const

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

int	GetRanking () const

std::string	GetLocalFileName () const
	Get a local file name for reading. More...

virtual void	SetDefaultDataNodeProperties (DataNode *node, const std::string &filePath)

Detailed Description

The reader service for the MITK example data type.

Definition at line 31 of file mitkExampleDataStructureReaderService.h.

Member Typedef Documentation

typedef mitk::ExampleDataStructure mitk::ExampleDataStructureReaderService::OutputType

Definition at line 34 of file mitkExampleDataStructureReaderService.h.

Constructor & Destructor Documentation

mitk::ExampleDataStructureReaderService::ExampleDataStructureReaderService ( const ExampleDataStructureReaderService & other )

Definition at line 29 of file mitkExampleDataStructureReaderService.cpp.

mitk::ExampleDataStructureReaderService::ExampleDataStructureReaderService ( )

Definition at line 34 of file mitkExampleDataStructureReaderService.cpp.

References mitk::AbstractFileReader::RegisterService().

mitk::ExampleDataStructureReaderService::~ExampleDataStructureReaderService ( )

virtual

Definition at line 41 of file mitkExampleDataStructureReaderService.cpp.

Member Function Documentation

std::vector< itk::SmartPointer< BaseData > > mitk::ExampleDataStructureReaderService::Read ( )

overridevirtual

Reads a path or stream and creates a list of BaseData objects.

This method must be implemented for each specific reader. Call GetInputStream() first and check for a non-null stream to read from. If the input stream is NULL, use GetInputLocation() to read from a local file-system path.

If the reader cannot use streams directly, use GetLocalFileName() instead.

Returns: The created BaseData objects.

Exceptions

mitk::Exception

See also: GetLocalFileName(); IFileReader::Read()

Implements mitk::AbstractFileReader.

Definition at line 42 of file mitkExampleDataStructureReaderService.cpp.

References mitk::AbstractFileReader::GetInputLocation(), line, MITK_ERROR, MITK_INFO, mitkThrow, and mitk::ExampleDataStructure::New().

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

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation