Medical Imaging Interaction Toolkit  2018.4.99-3e3f1a6e
Medical Imaging Interaction Toolkit
mitk::USDeviceReaderXML Class Reference

#include <mitkUSDeviceReaderXML.h>

Inheritance diagram for mitk::USDeviceReaderXML:
Collaboration diagram for mitk::USDeviceReaderXML:

Classes

struct  USDeviceConfigData_
 

Public Types

typedef struct mitk::USDeviceReaderXML::USDeviceConfigData_ USDeviceConfigData
 
- 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
 

Public Member Functions

 USDeviceReaderXML ()
 
 ~USDeviceReaderXML () override
 
std::vector< itk::SmartPointer< BaseData > > Read () override
 Reads a path or stream and creates a list of BaseData objects. More...
 
bool ReadUltrasoundDeviceConfiguration ()
 
void SetFilename (std::string filename)
 
USDeviceConfigDataGetUSDeviceConfigData ()
 
- 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< 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

 USDeviceReaderXML (const USDeviceReaderXML &other)
 
mitk::USDeviceReaderXMLClone () const override
 
void ExtractAttributeInformationOfUltrasoundDeviceTag (TiXmlElement *element)
 Extracts all stored attribute information of the ULTRASOUNDDEVICE-Tag. More...
 
void ExtractAttributeInformationOfGeneralSettingsTag (TiXmlElement *element)
 Extracts all stored attribute information of the GENERALSETTINGS-Tag. More...
 
void ExtractProbe (TiXmlElement *element)
 Extracts all stored information of a single ultrasound probe. 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)
 

Additional Inherited Members

- 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...
 
- Protected Attributes inherited from mitk::AbstractFileReader
std::vector< std::string > m_ReadFiles
 

Detailed Description

Definition at line 27 of file mitkUSDeviceReaderXML.h.

Member Typedef Documentation

◆ USDeviceConfigData

Constructor & Destructor Documentation

◆ USDeviceReaderXML() [1/2]

mitk::USDeviceReaderXML::USDeviceReaderXML ( )

Definition at line 26 of file mitkUSDeviceReaderXML.cpp.

References mitk::AbstractFileReader::RegisterService().

Referenced by Clone().

◆ ~USDeviceReaderXML()

mitk::USDeviceReaderXML::~USDeviceReaderXML ( )
override

Definition at line 33 of file mitkUSDeviceReaderXML.cpp.

◆ USDeviceReaderXML() [2/2]

mitk::USDeviceReaderXML::USDeviceReaderXML ( const USDeviceReaderXML other)
protected

Definition at line 42 of file mitkUSDeviceReaderXML.cpp.

Member Function Documentation

◆ Clone()

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

Implements mitk::AbstractFileReader.

Definition at line 46 of file mitkUSDeviceReaderXML.cpp.

References USDeviceReaderXML().

◆ ExtractAttributeInformationOfGeneralSettingsTag()

◆ ExtractAttributeInformationOfUltrasoundDeviceTag()

◆ ExtractProbe()

void mitk::USDeviceReaderXML::ExtractProbe ( TiXmlElement *  element)
protected

◆ GetUSDeviceConfigData()

mitk::USDeviceReaderXML::USDeviceConfigData & mitk::USDeviceReaderXML::GetUSDeviceConfigData ( )

◆ Read()

std::vector< itk::SmartPointer< mitk::BaseData > > mitk::USDeviceReaderXML::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 54 of file mitkUSDeviceReaderXML.cpp.

References MITK_WARN.

◆ ReadUltrasoundDeviceConfiguration()

◆ SetFilename()

void mitk::USDeviceReaderXML::SetFilename ( std::string  filename)

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