Medical Imaging Interaction Toolkit  2018.4.99-701c8286
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 ()
 
 ~NavigationDataReaderXML () override
 
- 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
 
std::vector< itk::SmartPointer< BaseData > > Read () override
 Reads a path or stream and creates a list of BaseData objects. More...
 
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< IFileReaderRegisterService (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

std::vector< itk::SmartPointer< BaseData > > DoRead () override
 
 NavigationDataReaderXML (const NavigationDataReaderXML &other)
 
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 () override
 
 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...
 
- 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::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 30 of file mitkNavigationDataReaderXML.h.

Constructor & Destructor Documentation

◆ NavigationDataReaderXML() [1/2]

mitk::NavigationDataReaderXML::NavigationDataReaderXML ( )

◆ ~NavigationDataReaderXML()

mitk::NavigationDataReaderXML::~NavigationDataReaderXML ( )
override

◆ NavigationDataReaderXML() [2/2]

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

Member Function Documentation

◆ Clone()

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

◆ DoRead()

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

Method that should be implemented by derived classes and does the real loading. This method is called by Read(). 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.

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

◆ GetNumberOfNavigationDatas()

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 nullptr.
Throwsan exception if the input stream has an XML incompatible format.

◆ ReadNavigationData()

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

◆ ReadNavigationDataSet()

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

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

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

Member Data Documentation

◆ m_currentNode

TiXmlNode* mitk::NavigationDataReaderXML::m_currentNode
protected

Definition at line 57 of file mitkNavigationDataReaderXML.h.

◆ m_ErrorMessage

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

stores the error message if the stream is invalid

Definition at line 66 of file mitkNavigationDataReaderXML.h.

◆ m_FileName

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

Definition at line 54 of file mitkNavigationDataReaderXML.h.

◆ m_FileVersion

int mitk::NavigationDataReaderXML::m_FileVersion
protected

indicates which XML encoding is used

Definition at line 59 of file mitkNavigationDataReaderXML.h.

◆ m_NumberOfOutputs

int mitk::NavigationDataReaderXML::m_NumberOfOutputs
protected

stores the number of outputs known from the XML document

Definition at line 60 of file mitkNavigationDataReaderXML.h.

◆ m_parentElement

TiXmlElement* mitk::NavigationDataReaderXML::m_parentElement
protected

Definition at line 56 of file mitkNavigationDataReaderXML.h.

◆ m_StreamEnd

bool mitk::NavigationDataReaderXML::m_StreamEnd
protected

stores if the input stream arrived at end

Definition at line 64 of file mitkNavigationDataReaderXML.h.

◆ m_StreamValid

bool mitk::NavigationDataReaderXML::m_StreamValid
protected

stores if the input stream is valid or not

Definition at line 65 of file mitkNavigationDataReaderXML.h.


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