#include <mitkSimulationIO.h>

Inheritance diagram for mitk::SimulationIO:

Collaboration diagram for mitk::SimulationIO:

Public Member Functions
	SimulationIO ()

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

ConfidenceLevel	GetReaderConfidenceLevel () const override

void	Write () override
	Write the base data to the specified location or output stream. More...

ConfidenceLevel	GetWriterConfidenceLevel () const override

Public Member Functions inherited from mitk::AbstractFileIO
Options	GetReaderOptions () const

us::Any	GetReaderOption (const std::string &name) const

void	SetReaderOptions (const Options &options)

void	SetReaderOption (const std::string &name, const us::Any &value)

Options	GetWriterOptions () const

us::Any	GetWriterOption (const std::string &name) const

void	SetWriterOptions (const Options &options)

void	SetWriterOption (const std::string &name, const us::Any &value)

std::pair< us::ServiceRegistration< IFileReader >, us::ServiceRegistration< IFileWriter > >	RegisterService (us::ModuleContext *context=us::GetModuleContext())

Public Member Functions inherited from mitk::AbstractFileIOReader
virtual ConfidenceLevel	GetConfidenceLevel () const override
	The confidence level of the reader or writer implementation. 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 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 ()

Public Member Functions inherited from mitk::AbstractFileIOWriter
virtual ConfidenceLevel	GetConfidenceLevel () const override
	The confidence level of the reader or writer implementation. More...

Public Member Functions inherited from mitk::AbstractFileWriter
virtual void	SetInput (const BaseData *data) override
	Set the input data for writing. More...

virtual const BaseData *	GetInput () const override
	Get the input data set via SetInput(). More...

virtual void	SetOutputLocation (const std::string &location) override
	Set the output location. More...

virtual std::string	GetOutputLocation () const override
	Get the current output location. More...

virtual void	SetOutputStream (const std::string &location, std::ostream *os) override
	Set an output stream for writing. More...

virtual std::ostream *	GetOutputStream () const override
	Get the output stream. More...

MimeType	GetRegisteredMimeType () const

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< IFileWriter >	RegisterService (us::ModuleContext *context=us::GetModuleContext())

void	UnregisterService ()

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

Additional Inherited Members
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

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...

Static Public Member Functions inherited from mitk::IFileWriter
static std::string	PROP_BASEDATA_TYPE ()
	Service property name for the supported mitk::BaseData sub-class. More...

Protected Member Functions inherited from mitk::AbstractFileIO
	AbstractFileIO (const AbstractFileIO &other)

	AbstractFileIO (const std::string &baseDataType)

	AbstractFileIO (const std::string &baseDataType, const CustomMimeType &mimeType, const std::string &description)

void	SetMimeType (const CustomMimeType &mimeType)

const CustomMimeType *	GetMimeType () const

void	SetReaderDescription (const std::string &description)

std::string	GetReaderDescription () const

void	SetWriterDescription (const std::string &description)

std::string	GetWriterDescription () const

void	SetDefaultReaderOptions (const Options &defaultOptions)

Options	GetDefaultReaderOptions () const

void	SetDefaultWriterOptions (const Options &defaultOptions)

Options	GetDefaultWriterOptions () const

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

int	GetReaderRanking () const

void	SetWriterRanking (int ranking)

int	GetWriterRanking () const

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

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

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)

Protected Member Functions inherited from mitk::AbstractFileIOWriter
	AbstractFileIOWriter (const std::string &baseDataType)

	AbstractFileIOWriter (const std::string &baseDataType, const CustomMimeType &mimeType, const std::string &description)

Protected Member Functions inherited from mitk::AbstractFileWriter
	~AbstractFileWriter ()

	AbstractFileWriter (const AbstractFileWriter &other)

	AbstractFileWriter (const std::string &baseDataType)

	AbstractFileWriter (const std::string &baseDataType, 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)
	Sets a human readable description of this writer. More...

std::string	GetDescription () const

void	SetDefaultOptions (const Options &defaultOptions)

Options	GetDefaultOptions () const

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

int	GetRanking () const

void	SetBaseDataType (const std::string &baseDataType)
	Sets the name of the mitk::Basedata that this writer is able to handle. More...

virtual std::string	GetBaseDataType () const

void	ValidateOutputLocation () const

Detailed Description

Definition at line 25 of file mitkSimulationIO.h.

Constructor & Destructor Documentation

mitk::SimulationIO::SimulationIO ( )

Definition at line 39 of file mitkSimulationIO.cpp.

References mitk::AbstractFileIO::RegisterService().

Member Function Documentation

mitk::IFileIO::ConfidenceLevel mitk::SimulationIO::GetReaderConfidenceLevel ( ) const

overridevirtual

Reimplemented from mitk::AbstractFileIO.

Definition at line 112 of file mitkSimulationIO.cpp.

References mitk::AbstractFileIO::GetReaderConfidenceLevel().

mitk::IFileIO::ConfidenceLevel mitk::SimulationIO::GetWriterConfidenceLevel ( ) const

overridevirtual

Reimplemented from mitk::AbstractFileIO.

Definition at line 157 of file mitkSimulationIO.cpp.

References mitk::AbstractFileIO::GetWriterConfidenceLevel().

std::vector< mitk::BaseData::Pointer > mitk::SimulationIO::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 45 of file mitkSimulationIO.cpp.

References mitk::ISimulationService::GetActiveSimulation(), mitk::GetSimulationService(), mitkThrow, mitk::Simulation::New(), mitk::StringProperty::New(), and mitk::ISimulationService::SetActiveSimulation().

void mitk::SimulationIO::Write ( )

overridevirtual

Write the base data to the specified location or output stream.

This method must be implemented for each specific writer. Call GetOutputStream() first and check for a non-null stream to write to. If the output stream is NULL, use GetOutputLocation() to write to a local file-system path.

If the reader cannot use streams directly, use GetLocalFile() to retrieve a temporary local file name instead.

Exceptions

mitk::Exception

See also: GetLocalFile(); IFileWriter::Write()

Implements mitk::AbstractFileWriter.

Definition at line 131 of file mitkSimulationIO.cpp.

References mitk::AbstractFileWriter::LocalFile::GetFileName(), mitk::BaseData::GetProperty(), and mitkThrow.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation