#include <mitkNavigationDataReaderXML.h>

Inheritance diagram for mitk::NavigationDataReaderXML:

Collaboration diagram for mitk::NavigationDataReaderXML:

[legend]

Public Member Functions
	NavigationDataReaderXML ()

	~NavigationDataReaderXML () override

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
void	SetInput (const std::string &location) override
	Set the input location. More...

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

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

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

MimeType	GetRegisteredMimeType () const

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

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

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

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

void	SetOptions (const Options &options) override

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

void	AddProgressCallback (const ProgressCallback &callback) override

void	RemoveProgressCallback (const ProgressCallback &callback) override

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

void	UnregisterService ()

std::vector< std::string >	GetReadFiles () override

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

virtual	~IFileReader ()

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

Protected Member Functions
	NavigationDataReaderXML (const NavigationDataReaderXML &other)

mitk::NavigationDataReaderXML *	Clone () const override

NavigationDataSet::Pointer	ReadNavigationDataSet ()

mitk::NavigationData::Pointer	ReadVersion1 ()
	This method reads one line of the XML document and returns the data as a NavigationData object If there is a new file version another method must be added which reads this data. More...

mitk::NavigationData::Pointer	ReadNavigationData (TiXmlElement *elem)

unsigned int	GetFileVersion (std::istream *stream)
	Creates a stream out of the filename given by the variable m_FileName. The stream is then set to m_Stream. More...

unsigned int	GetNumberOfNavigationDatas (std::istream *stream)
	Returns the number of tracked tools out of the XML document. More...

void	StreamInvalid (std::string message)
	This is a helping method which gives an error message and throws an exception with the given message. It can be used if a stream is found to be invalid. More...

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

	~AbstractFileReader () override

	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 Attributes
std::string	m_FileName

TiXmlElement *	m_parentElement

TiXmlNode *	m_currentNode

int	m_FileVersion
	indicates which XML encoding is used More...

int	m_NumberOfOutputs
	stores the number of outputs known from the XML document More...

bool	m_StreamEnd
	stores if the input stream arrived at end More...

bool	m_StreamValid
	stores if the input stream is valid or not More...

std::string	m_ErrorMessage
	stores the error message if the stream is invalid More...

Protected Attributes inherited from mitk::AbstractFileReader
std::vector< std::string >	m_ReadFiles

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

Detailed Description

Definition at line 30 of file mitkNavigationDataReaderXML.h.

Constructor & Destructor Documentation

◆ NavigationDataReaderXML() [1/2]

mitk::NavigationDataReaderXML::NavigationDataReaderXML ( )

Definition at line 24 of file mitkNavigationDataReaderXML.cpp.

References mitk::AbstractFileReader::RegisterService().

Referenced by Clone().

◆ ~NavigationDataReaderXML()

mitk::NavigationDataReaderXML::~NavigationDataReaderXML ( )

override

Definition at line 31 of file mitkNavigationDataReaderXML.cpp.

◆ NavigationDataReaderXML() [2/2]

mitk::NavigationDataReaderXML::NavigationDataReaderXML ( const NavigationDataReaderXML & other )

protected

Definition at line 35 of file mitkNavigationDataReaderXML.cpp.

Member Function Documentation

◆ Clone()

mitk::NavigationDataReaderXML * mitk::NavigationDataReaderXML::Clone ( ) const

overrideprotectedvirtual

Implements mitk::AbstractFileReader.

Definition at line 39 of file mitkNavigationDataReaderXML.cpp.

References NavigationDataReaderXML().

◆ GetFileVersion()

unsigned int mitk::NavigationDataReaderXML::GetFileVersion ( std::istream * stream )

protected

Creates a stream out of the filename given by the variable m_FileName. The stream is then set to m_Stream.

Exceptions

mitk::IGTIOException	Throws an exception if file does not exist
mitk::IGTException	Throws an exception if the stream is nullptr Returns the file version out of the XML document.
mitk::IGTException	Throws an mitk::IGTException an exception if stream is nullptr or not good.
mitk::IGTIOException	Throws an mitk::IGTIOException if the stream has an incompatible XML format.

Definition at line 287 of file mitkNavigationDataReaderXML.cpp.

References m_parentElement, MITK_ERROR, and mitkThrowException.

Referenced by Read().

◆ GetNumberOfNavigationDatas()

unsigned int mitk::NavigationDataReaderXML::GetNumberOfNavigationDatas ( std::istream * stream )

protected

Returns the number of tracked tools out of the XML document.

Exceptions

Throws	an exception if stream is nullptr.
Throws	an exception if the input stream has an XML incompatible format.

Definition at line 328 of file mitkNavigationDataReaderXML.cpp.

References m_parentElement, MITK_ERROR, and mitkThrowException.

Referenced by Read().

◆ Read()

std::vector< itk::SmartPointer< mitk::BaseData > > mitk::NavigationDataReaderXML::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 nullptr, 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 mitkNavigationDataReaderXML.cpp.

References GetFileVersion(), mitk::AbstractFileReader::GetInputLocation(), mitk::AbstractFileReader::GetInputStream(), GetNumberOfNavigationDatas(), Json::in(), m_FileName, m_FileVersion, m_NumberOfOutputs, m_parentElement, mitkThrowException, ReadNavigationDataSet(), and StreamInvalid().

◆ ReadNavigationData()

mitk::NavigationData::Pointer mitk::NavigationDataReaderXML::ReadNavigationData ( TiXmlElement * elem )

protected

Definition at line 207 of file mitkNavigationDataReaderXML.cpp.

References mitkThrow, and mitk::NavigationData::New().

Referenced by ReadVersion1().

◆ ReadNavigationDataSet()

mitk::NavigationDataSet::Pointer mitk::NavigationDataReaderXML::ReadNavigationDataSet ( )

protected

Definition at line 137 of file mitkNavigationDataReaderXML.cpp.

References m_NumberOfOutputs, MITK_WARN, and ReadVersion1().

Referenced by Read().

◆ ReadVersion1()

mitk::NavigationData::Pointer mitk::NavigationDataReaderXML::ReadVersion1 ( )

protected

This method reads one line of the XML document and returns the data as a NavigationData object If there is a new file version another method must be added which reads this data.

Exceptions

mitk::IGTException Throws an exceptions if file is damaged.

Definition at line 171 of file mitkNavigationDataReaderXML.cpp.

References m_currentNode, m_parentElement, mitkThrowException, and ReadNavigationData().

Referenced by ReadNavigationDataSet().

◆ StreamInvalid()

void mitk::NavigationDataReaderXML::StreamInvalid ( std::string message )

protected

This is a helping method which gives an error message and throws an exception with the given message. It can be used if a stream is found to be invalid.

Exceptions

mitk::IGTIOException Always throws an exception.help method which sets the stream invalid and displays an error

Definition at line 357 of file mitkNavigationDataReaderXML.cpp.

References m_ErrorMessage, m_StreamEnd, m_StreamValid, and mitkThrowException.

Referenced by Read().