Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::NavigationDataReaderXML Class Reference

#include <mitkNavigationDataReaderXML.h>

Inheritance diagram for mitk::NavigationDataReaderXML:
Collaboration diagram for mitk::NavigationDataReaderXML:

Public Member Functions

 NavigationDataReaderXML ()
 
virtual ~NavigationDataReaderXML ()
 
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< IFileReaderRegisterService (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 ()
 

Protected Member Functions

 NavigationDataReaderXML (const NavigationDataReaderXML &other)
 
virtual mitk::NavigationDataReaderXMLClone () 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 ()
 
 AbstractFileReader (const AbstractFileReader &other)
 
 AbstractFileReader (const CustomMimeType &mimeType, const std::string &description)
 
virtual us::ServiceProperties GetServiceProperties () const
 
virtual us::ServiceRegistration< CustomMimeTypeRegisterMimeType (us::ModuleContext *context)
 
void SetMimeType (const CustomMimeType &mimeType)
 
const CustomMimeTypeGetMimeType () 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...
 

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::AnyOptions
 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 32 of file mitkNavigationDataReaderXML.h.

Constructor & Destructor Documentation

mitk::NavigationDataReaderXML::NavigationDataReaderXML ( )
mitk::NavigationDataReaderXML::~NavigationDataReaderXML ( )
virtual

Definition at line 35 of file mitkNavigationDataReaderXML.cpp.

mitk::NavigationDataReaderXML::NavigationDataReaderXML ( const NavigationDataReaderXML other)
protected

Definition at line 39 of file mitkNavigationDataReaderXML.cpp.

Member Function Documentation

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

Implements mitk::AbstractFileReader.

Definition at line 43 of file mitkNavigationDataReaderXML.cpp.

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::IGTIOExceptionThrows an exception if file does not exist
mitk::IGTExceptionThrows an exception if the stream is NULL Returns the file version out of the XML document.
mitk::IGTExceptionThrows an mitk::IGTException an exception if stream is NULL or not good.
mitk::IGTIOExceptionThrows an mitk::IGTIOException if the stream has an incompatible XML format.

Definition at line 291 of file mitkNavigationDataReaderXML.cpp.

References MITK_ERROR, and mitkThrowException.

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

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

Exceptions
Throwsan exception if stream is NULL.
Throwsan exception if the input stream has an XML incompatible format.

Definition at line 332 of file mitkNavigationDataReaderXML.cpp.

References MITK_ERROR, and mitkThrowException.

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 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 49 of file mitkNavigationDataReaderXML.cpp.

References Json::in().

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

Definition at line 211 of file mitkNavigationDataReaderXML.cpp.

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

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

Definition at line 141 of file mitkNavigationDataReaderXML.cpp.

References MITK_WARN, and mitk::New().

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::IGTExceptionThrows an exceptions if file is damaged.

Definition at line 175 of file mitkNavigationDataReaderXML.cpp.

References mitkThrowException.

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::IGTIOExceptionAlways throws an exception.help method which sets the stream invalid and displays an error

Definition at line 361 of file mitkNavigationDataReaderXML.cpp.

References mitkThrowException.

Member Data Documentation

TiXmlNode* mitk::NavigationDataReaderXML::m_currentNode
protected

Definition at line 59 of file mitkNavigationDataReaderXML.h.

std::string mitk::NavigationDataReaderXML::m_ErrorMessage
protected

stores the error message if the stream is invalid

Definition at line 68 of file mitkNavigationDataReaderXML.h.

std::string mitk::NavigationDataReaderXML::m_FileName
protected

Definition at line 56 of file mitkNavigationDataReaderXML.h.

int mitk::NavigationDataReaderXML::m_FileVersion
protected

indicates which XML encoding is used

Definition at line 61 of file mitkNavigationDataReaderXML.h.

int mitk::NavigationDataReaderXML::m_NumberOfOutputs
protected

stores the number of outputs known from the XML document

Definition at line 62 of file mitkNavigationDataReaderXML.h.

TiXmlElement* mitk::NavigationDataReaderXML::m_parentElement
protected

Definition at line 58 of file mitkNavigationDataReaderXML.h.

bool mitk::NavigationDataReaderXML::m_StreamEnd
protected

stores if the input stream arrived at end

Definition at line 66 of file mitkNavigationDataReaderXML.h.

bool mitk::NavigationDataReaderXML::m_StreamValid
protected

stores if the input stream is valid or not

Definition at line 67 of file mitkNavigationDataReaderXML.h.


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