mitk::USDeviceWriterXML Class Reference

#include <mitkUSDeviceWriterXML.h>

Inheritance diagram for mitk::USDeviceWriterXML:

Public Member Functions
	USDeviceWriterXML ()
	~USDeviceWriterXML () override
void	Write () override
void	SetFilename (std::string filename)
	Sets the filename of the ultrasound device configuration file which should be created.
bool	WriteUltrasoundDeviceConfiguration (mitk::USDeviceReaderXML::USDeviceConfigData &config)
	Writes the configuration settings of an ultrasound device to a xml-file.

Protected Member Functions
	USDeviceWriterXML (const USDeviceWriterXML &other)
mitk::USDeviceWriterXML *	Clone () const override
void	CreateXmlInformationOfUltrasoundDeviceTag (tinyxml2::XMLDocument &document, tinyxml2::XMLElement *ultrasoundDeviceTag, mitk::USDeviceReaderXML::USDeviceConfigData &config)
	Creates the xml ULTRASOUNDDEVICE-Tag entry of the ultrasound video device configuration file.
void	CreateXmlInformationOfGeneralSettingsTag (tinyxml2::XMLElement *parentTag, tinyxml2::XMLElement *generalSettingsTag, mitk::USDeviceReaderXML::USDeviceConfigData &config)
	Creates the xml GENERALSETTINGS-Tag entry of the ultrasound video device configuration file.
void	CreateXmlInformationOfProbesTag (tinyxml2::XMLElement *parentTag, mitk::USDeviceReaderXML::USDeviceConfigData &config)
	Creates the xml PROBES-Tag entry of the ultrasound video device configuration file. All information of all configured probes is extracted and then stored in the xml file.

Detailed Description

Definition at line 28 of file mitkUSDeviceWriterXML.h.

Constructor & Destructor Documentation

USDeviceWriterXML() [1/2]

mitk::USDeviceWriterXML::USDeviceWriterXML

(

)

Definition at line 26 of file mitkUSDeviceWriterXML.cpp.

~USDeviceWriterXML()

mitk::USDeviceWriterXML::~USDeviceWriterXML ( )

override

Definition at line 37 of file mitkUSDeviceWriterXML.cpp.

USDeviceWriterXML() [2/2]

mitk::USDeviceWriterXML::USDeviceWriterXML ( const USDeviceWriterXML & other )

protected

Definition at line 33 of file mitkUSDeviceWriterXML.cpp.

Member Function Documentation

Clone()

mitk::USDeviceWriterXML * mitk::USDeviceWriterXML::Clone ( ) const

overrideprotected

Definition at line 41 of file mitkUSDeviceWriterXML.cpp.

CreateXmlInformationOfGeneralSettingsTag()

void mitk::USDeviceWriterXML::CreateXmlInformationOfGeneralSettingsTag ( tinyxml2::XMLElement * parentTag, tinyxml2::XMLElement * generalSettingsTag, mitk::USDeviceReaderXML::USDeviceConfigData & config )

protected

Creates the xml GENERALSETTINGS-Tag entry of the ultrasound video device configuration file.

Parameters

parentTag	The xml parent tag of the GENERALSETTINGS-Tag. This is the ULTRASOUNDDEVICE-Tag.
generalSettingsTag	The GENERALSETTINGS-Tag which should be created.
config	The struct containing all information of the ultrasound device.

Definition at line 102 of file mitkUSDeviceWriterXML.cpp.

CreateXmlInformationOfProbesTag()

void mitk::USDeviceWriterXML::CreateXmlInformationOfProbesTag ( tinyxml2::XMLElement * parentTag, mitk::USDeviceReaderXML::USDeviceConfigData & config )

protected

Creates the xml PROBES-Tag entry of the ultrasound video device configuration file. All information of all configured probes is extracted and then stored in the xml file.

Parameters

parentTag	The xml parent tag of the GENERALSETTINGS-Tag. This is the ULTRASOUNDDEVICE-Tag.
config	The struct containing all information of the ultrasound device.

Definition at line 116 of file mitkUSDeviceWriterXML.cpp.

CreateXmlInformationOfUltrasoundDeviceTag()

void mitk::USDeviceWriterXML::CreateXmlInformationOfUltrasoundDeviceTag ( tinyxml2::XMLDocument & document, tinyxml2::XMLElement * ultrasoundDeviceTag, mitk::USDeviceReaderXML::USDeviceConfigData & config )

protected

Creates the xml ULTRASOUNDDEVICE-Tag entry of the ultrasound video device configuration file.

Parameters

document	A reference to the xml document.
ultrasoundDeviceTag	The ULTRASOUNDDEVICETAG which should be created.
config	The struct containing all information of the ultrasound device.

Definition at line 80 of file mitkUSDeviceWriterXML.cpp.

SetFilename()

void mitk::USDeviceWriterXML::SetFilename

(

std::string

filename

)

Sets the filename of the ultrasound device configuration file which should be created.

Definition at line 55 of file mitkUSDeviceWriterXML.cpp.

Write()

void mitk::USDeviceWriterXML::Write ( )

override

Definition at line 46 of file mitkUSDeviceWriterXML.cpp.

WriteUltrasoundDeviceConfiguration()

bool mitk::USDeviceWriterXML::WriteUltrasoundDeviceConfiguration

(

mitk::USDeviceReaderXML::USDeviceConfigData &

config

)

Writes the configuration settings of an ultrasound device to a xml-file.

Parameters

config

The struct containing all information of the ultrasound device.

Definition at line 60 of file mitkUSDeviceWriterXML.cpp.

---

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

• Modules/US/USModel/mitkUSDeviceWriterXML.h
• Modules/US/USModel/mitkUSDeviceWriterXML.cpp