Read and write mitk::PlanarFigure objects to/from XML files. More...

#include <mitkPlanarFigureIO.h>

Inheritance diagram for mitk::PlanarFigureIO:

[legend]

Collaboration diagram for mitk::PlanarFigureIO:

[legend]

Public Types
typedef mitk::PlanarFigure	InputType

Public Types inherited from mitk::IFileIO
enum	ConfidenceLevel { Unsupported , PartiallySupported , Supported }
	A confidence level describing the reader's or writer's ability to handle the given data or file format. More...

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

typedef mitk::MessageAbstractDelegate1< float >	ProgressCallback
	Callback delegate type for progress reporting. More...

Public Member Functions
	PlanarFigureIO ()
	Default constructor. Registers reader/writer for the PlanarFigure MIME type. More...

ConfidenceLevel	GetReaderConfidenceLevel () const override
	Return the confidence level for reading the given file as a PlanarFigure. More...

void	Write () override
	Write the PlanarFigure to an XML file. More...

ConfidenceLevel	GetWriterConfidenceLevel () const override
	Return the confidence level for writing the given data as a PlanarFigure. More...

std::vector< itk::SmartPointer< BaseData > >	Read () override
	Read data and create a list of BaseData objects. More...

DataStorage::SetOfObjects::Pointer	Read (mitk::DataStorage &ds) override
	Read data and add it to the given DataStorage. More...

Public Member Functions inherited from mitk::AbstractFileIO
Options	GetReaderOptions () const
	Get the reader-specific options. More...

us::Any	GetReaderOption (const std::string &name) const
	Get the value of a specific reader option. More...

void	SetReaderOptions (const Options &options)
	Set multiple reader options at once. More...

void	SetReaderOption (const std::string &name, const us::Any &value)
	Set a single reader option. More...

Options	GetWriterOptions () const
	Get the writer-specific options. More...

us::Any	GetWriterOption (const std::string &name) const
	Get the value of a specific writer option. More...

void	SetWriterOptions (const Options &options)
	Set multiple writer options at once. More...

void	SetWriterOption (const std::string &name, const us::Any &value)
	Set a single writer option. More...

std::pair< us::ServiceRegistration< IFileReader >, us::ServiceRegistration< IFileWriter > >	RegisterService (us::ModuleContext *context=us::GetModuleContext())
	Register both reader and writer as CppMicroServices services. More...

Public Member Functions inherited from mitk::AbstractFileIOReader
ConfidenceLevel	GetConfidenceLevel () const override
	Get the confidence level of this reader or writer for the current input. More...

Public Member Functions inherited from mitk::AbstractFileReader
void	SetInput (const std::string &location) override
	Set the input file path, clearing any previously set input stream. More...

void	SetInput (const std::string &location, std::istream *is) override
	Set an input stream and associated location label. More...

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

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

MimeType	GetRegisteredMimeType () const
	Get the mime-type that was registered for this reader. More...

DataStorage::SetOfObjects::Pointer	Read (mitk::DataStorage &ds) override
	Read data and add it to the given DataStorage. More...

ConfidenceLevel	GetConfidenceLevel () const override
	Determine confidence for reading the current input. More...

Options	GetOptions () const override
	Get the current option values. More...

us::Any	GetOption (const std::string &name) const override
	Get the value of a specific option. More...

void	SetOptions (const Options &options) override
	Set multiple options at once. More...

void	SetOption (const std::string &name, const us::Any &value) override
	Set a single option value. More...

void	AddProgressCallback (const ProgressCallback &callback) override
	Register a progress callback. More...

void	RemoveProgressCallback (const ProgressCallback &callback) override
	Remove a previously registered progress callback. More...

us::ServiceRegistration< IFileReader >	RegisterService (us::ModuleContext *context=us::GetModuleContext())
	Register this reader as a CppMicroServices service. More...

void	UnregisterService ()
	Unregister this reader from the CppMicroServices registry. More...

std::vector< std::string >	GetReadFiles () override
	Get the list of files consumed during the last Read() call. More...

void	SetProperties (const PropertyList *properties) override
	Set base data properties as a source of meta data for reading. More...

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

virtual	~IFileReader ()

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

Public Member Functions inherited from mitk::AbstractFileIOWriter
ConfidenceLevel	GetConfidenceLevel () const override
	Get the confidence level of this reader or writer for the current input. More...

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

const BaseData *	GetInput () const override
	Get the input data. More...

void	SetOutputLocation (const std::string &location) override
	Set the output file-system path, clearing any output stream. More...

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

void	SetOutputStream (const std::string &location, std::ostream *os) override
	Set an output stream and associated location label. More...

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

ConfidenceLevel	GetConfidenceLevel () const override
	Determine confidence for writing the current input data. More...

MimeType	GetRegisteredMimeType () const
	Get the MIME type that was registered for this writer. More...

Options	GetOptions () const override
	Get the current option values. More...

us::Any	GetOption (const std::string &name) const override
	Get the value of a specific option. More...

void	SetOptions (const Options &options) override
	Set multiple options at once. More...

void	SetOption (const std::string &name, const us::Any &value) override
	Set a single option value. More...

void	AddProgressCallback (const ProgressCallback &callback) override
	Register a progress callback. More...

void	RemoveProgressCallback (const ProgressCallback &callback) override
	Remove a previously registered progress callback. More...

us::ServiceRegistration< IFileWriter >	RegisterService (us::ModuleContext *context=us::GetModuleContext())
	Register this writer as a CppMicroServices service. More...

void	UnregisterService ()
	Unregister this writer from the CppMicroServices registry. More...

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

Protected Types
using	DoubleList = std::list< double >

Protected Member Functions
std::vector< itk::SmartPointer< BaseData > >	DoRead () override
	Read PlanarFigure objects from the file system. More...

DoubleList	GetDoubleAttributeListFromXMLNode (const tinyxml2::XMLElement e, const char attributeNameBase, unsigned int count)
	parses the element for the attributes name0 to nameN, where "name" and the number of attributes to read are passed as argument. Returns a list of double vales. More...

Protected Member Functions inherited from mitk::AbstractFileIO
	AbstractFileIO (const AbstractFileIO &other)
	Copy constructor. More...

	AbstractFileIO (const std::string &baseDataType)
	Construct with a BaseData type name only. More...

	AbstractFileIO (const std::string &baseDataType, const CustomMimeType &mimeType, const std::string &description)
	Construct with a BaseData type, MIME type, and description. More...

void	SetMimeType (const CustomMimeType &mimeType)
	Set the shared MIME type for both reader and writer. More...

const CustomMimeType *	GetMimeType () const
	Get the shared MIME type. More...

void	SetReaderDescription (const std::string &description)
	Set the description for the reader part. More...

std::string	GetReaderDescription () const
	Get the description of the reader part. More...

void	SetWriterDescription (const std::string &description)
	Set the description for the writer part. More...

std::string	GetWriterDescription () const
	Get the description of the writer part. More...

void	SetDefaultReaderOptions (const Options &defaultOptions)
	Set default options for the reader part. More...

Options	GetDefaultReaderOptions () const
	Get the default options for the reader part. More...

void	SetDefaultWriterOptions (const Options &defaultOptions)
	Set default options for the writer part. More...

Options	GetDefaultWriterOptions () const
	Get the default options for the writer part. More...

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

int	GetReaderRanking () const
	Get the service ranking for the reader part. More...

void	SetWriterRanking (int ranking)
	Set the service ranking for the writer part. More...

int	GetWriterRanking () const
	Get the service ranking for the writer part. More...

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

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

Protected Member Functions inherited from mitk::AbstractFileReader
	AbstractFileReader ()
	Default constructor. More...

	~AbstractFileReader () override

	AbstractFileReader (const AbstractFileReader &other)
	Copy constructor. More...

	AbstractFileReader (const CustomMimeType &mimeType, const std::string &description)
	Associate this reader instance with the given MIME type. More...

virtual us::ServiceProperties	GetServiceProperties () const
	Get the service properties for registration. More...

virtual us::ServiceRegistration< CustomMimeType >	RegisterMimeType (us::ModuleContext *context)
	Register a new CustomMimeType service object. More...

void	SetMimeType (const CustomMimeType &mimeType)
	Set the MIME type this reader can handle. More...

const CustomMimeType *	GetMimeType () const
	Get the MIME type this reader can handle. More...

void	SetMimeTypePrefix (const std::string &prefix)
	Set the prefix used for auto-generated MIME type names. More...

std::string	GetMimeTypePrefix () const
	Get the current MIME type name prefix. More...

void	SetDescription (const std::string &description)
	Set the human-readable description of this reader. More...

std::string	GetDescription () const
	Get the human-readable description of this reader. More...

void	SetDefaultOptions (const Options &defaultOptions)
	Set the default options for this reader. More...

Options	GetDefaultOptions () const
	Get the default options for this reader. More...

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

int	GetRanking () const
	Get the service ranking for this file reader. More...

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

virtual void	SetDefaultDataNodeProperties (DataNode *node, const std::string &filePath)
	Set default properties on a DataNode after reading. More...

const PropertyList *	GetProperties () const override
	Get the properties set via SetProperties(). More...

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 () override

	AbstractFileWriter (const AbstractFileWriter &other)
	Copy constructor. More...

	AbstractFileWriter (const std::string &baseDataType)
	Construct a writer for the given BaseData type name. More...

	AbstractFileWriter (const std::string &baseDataType, const CustomMimeType &mimeType, const std::string &description)
	Construct a writer for the given BaseData type, MIME type, and description. More...

virtual us::ServiceProperties	GetServiceProperties () const
	Get the service properties for registration. More...

virtual us::ServiceRegistration< CustomMimeType >	RegisterMimeType (us::ModuleContext *context)
	Register a new CustomMimeType service object. More...

void	SetMimeType (const CustomMimeType &mimeType)
	Set the MIME type this writer can handle. More...

const CustomMimeType *	GetMimeType () const
	Get the MIME type this writer can handle. More...

void	SetMimeTypePrefix (const std::string &prefix)
	Set the prefix used for auto-generated MIME type names. More...

std::string	GetMimeTypePrefix () const
	Get the current MIME type name prefix. More...

void	SetDescription (const std::string &description)
	Set a human-readable description of this writer. More...

std::string	GetDescription () const
	Get the human-readable description of this writer. More...

void	SetDefaultOptions (const Options &defaultOptions)
	Set the default options for this writer. More...

Options	GetDefaultOptions () const
	Get the default options for this writer. More...

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

int	GetRanking () const
	Get the service ranking for this file writer. More...

void	SetBaseDataType (const std::string &baseDataType)
	Set the name of the mitk::BaseData sub-class this writer supports. More...

virtual std::string	GetBaseDataType () const
	Get the name of the mitk::BaseData sub-class this writer supports. More...

void	ValidateOutputLocation () const
	Validate the output location or stream. More...

Static Protected Member Functions
static mitk::Vector3D	GetVectorFromXMLNode (const tinyxml2::XMLElement *e)
	parses the element for the attributes x,y,z and returns a mitk::Vector3D filled with these values More...

static mitk::Point3D	GetPointFromXMLNode (const tinyxml2::XMLElement *e)
	parses the element for the attributes x,y,z and returns a mitk::Point3D filled with these values More...

static tinyxml2::XMLElement *	CreateXMLVectorElement (tinyxml2::XMLDocument &doc, const char *name, itk::FixedArray< mitk::ScalarType, 3 > v)
	creates a TinyXML element that contains x, y, and z values More...

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

static std::string	PROP_MIMETYPE ()
	Service property name for the mime-type associated with this reader or 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 Attributes inherited from mitk::AbstractFileReader
std::vector< std::string >	m_ReadFiles
	List of files consumed during the last Read() call. Must be filled by DoRead(). More...

Detailed Description

Read and write mitk::PlanarFigure objects to/from XML files.

Definition at line 31 of file mitkPlanarFigureIO.h.

Member Typedef Documentation

◆ DoubleList

using mitk::PlanarFigureIO::DoubleList = std::list<double>

protected

Definition at line 62 of file mitkPlanarFigureIO.h.

◆ InputType

typedef mitk::PlanarFigure mitk::PlanarFigureIO::InputType

Definition at line 34 of file mitkPlanarFigureIO.h.

Constructor & Destructor Documentation

◆ PlanarFigureIO()

mitk::PlanarFigureIO::PlanarFigureIO ( )

Default constructor. Registers reader/writer for the PlanarFigure MIME type.

Member Function Documentation

◆ CreateXMLVectorElement()

static tinyxml2::XMLElement* mitk::PlanarFigureIO::CreateXMLVectorElement	(	tinyxml2::XMLDocument &	doc,
		const char *	name,
		itk::FixedArray< mitk::ScalarType, 3 >	v
	)

staticprotected

creates a TinyXML element that contains x, y, and z values

Documentation

Parameters

[in]	doc
[in]	name	the name of the XML element
[in]	v	the vector or point that contains the x, y and z values

Returns: returns a XML element named name and three attributes x, y and z.

◆ DoRead()

std::vector<itk::SmartPointer<BaseData> > mitk::PlanarFigureIO::DoRead ( )

overrideprotectedvirtual

Read PlanarFigure objects from the file system.

Returns: A vector of mitk::PlanarFigures.

Exceptions

mitk::Exception if a parsing error occurs.

Implements mitk::AbstractFileReader.

◆ GetDoubleAttributeListFromXMLNode()

DoubleList mitk::PlanarFigureIO::GetDoubleAttributeListFromXMLNode	(	const tinyxml2::XMLElement *	e,
		const char *	attributeNameBase,
		unsigned int	count
	)

protected

parses the element for the attributes name0 to nameN, where "name" and the number of attributes to read are passed as argument. Returns a list of double vales.

Parameters

[in]	e	the XML element that will be parsed
[in]	attributeNameBase	the basic name of the parameters
[in]	count	the number of parameters

Returns: returns a mitk::Point3D with the values x,y,z

◆ GetPointFromXMLNode()

static mitk::Point3D mitk::PlanarFigureIO::GetPointFromXMLNode ( const tinyxml2::XMLElement * e )

staticprotected

parses the element for the attributes x,y,z and returns a mitk::Point3D filled with these values

Parameters

[in] e the XML element that will be parsed

Returns: returns a mitk::Point3D with the values x,y,z

◆ GetReaderConfidenceLevel()

ConfidenceLevel mitk::PlanarFigureIO::GetReaderConfidenceLevel ( ) const

overridevirtual

Return the confidence level for reading the given file as a PlanarFigure.

Reimplemented from mitk::AbstractFileIO.

◆ GetVectorFromXMLNode()

static mitk::Vector3D mitk::PlanarFigureIO::GetVectorFromXMLNode ( const tinyxml2::XMLElement * e )

staticprotected

parses the element for the attributes x,y,z and returns a mitk::Vector3D filled with these values

Parameters

[in] e the XML element that will be parsed

Returns: returns a mitk::Vector3D with the values x,y,z

◆ GetWriterConfidenceLevel()

ConfidenceLevel mitk::PlanarFigureIO::GetWriterConfidenceLevel ( ) const

overridevirtual

Return the confidence level for writing the given data as a PlanarFigure.

Reimplemented from mitk::AbstractFileIO.

◆ Read() [1/2]

std::vector<itk::SmartPointer<BaseData> > mitk::AbstractFileReader::Read

overridevirtual

Read data and create a list of BaseData objects.

The default implementation calls DoRead() and then annotates each resulting BaseData with meta-information about the reader, MIME type, input location, and reader options.

Returns: A vector of created BaseData objects.

Exceptions

mitk::Exception if reading fails.

Reimplemented from mitk::AbstractFileReader.

◆ Read() [2/2]

DataStorage::SetOfObjects::Pointer mitk::AbstractFileReader::Read

overridevirtual

Read data and add it to the given DataStorage.

Parameters

[in,out] ds The DataStorage to add nodes to.

Returns: The set of DataNode objects added to ds.

Exceptions

mitk::Exception if reading fails.

Reimplemented from mitk::AbstractFileReader.

◆ Write()

void mitk::PlanarFigureIO::Write ( )

overridevirtual

Write the PlanarFigure to an XML file.

Implements mitk::AbstractFileWriter.

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

mitkPlanarFigureIO.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DoubleList

◆ InputType

Constructor & Destructor Documentation

◆ PlanarFigureIO()

Member Function Documentation

◆ CreateXMLVectorElement()

◆ DoRead()

◆ GetDoubleAttributeListFromXMLNode()

◆ GetPointFromXMLNode()

◆ GetReaderConfidenceLevel()

◆ GetVectorFromXMLNode()

◆ GetWriterConfidenceLevel()

◆ Read() [1/2]

◆ Read() [2/2]

◆ Write()