#include <mitkUSDeviceWriterXML.h>

Inheritance diagram for mitk::USDeviceWriterXML:

[legend]

Collaboration diagram for mitk::USDeviceWriterXML:

[legend]

Public Member Functions
	USDeviceWriterXML ()

	~USDeviceWriterXML () override

void	Write () override
	Write the base data to the specified location or output stream. More...

void	SetFilename (std::string filename)
	Sets the filename of the ultrasound device configuration file which should be created. More...

bool	WriteUltrasoundDeviceConfiguration (mitk::USDeviceReaderXML::USDeviceConfigData &config)
	Writes the configuration settings of an ultrasound device to a xml-file. More...

void	Write () override=0
	Write the base data to the specified location or output stream. More...

Public Member Functions inherited from mitk::AbstractFileWriter
void	SetInput (const BaseData *data) override
	Set the input data for writing. More...

const BaseData *	GetInput () const override
	Get the input data set via SetInput(). More...

void	SetOutputLocation (const std::string &location) override
	Set the output location. More...

std::string	GetOutputLocation () const override
	Get the current output location. More...

void	SetOutputStream (const std::string &location, std::ostream *os) override
	Set an output stream for writing. More...

std::ostream *	GetOutputStream () const override
	Get the output stream. More...

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

MimeType	GetRegisteredMimeType () const

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< IFileWriter >	RegisterService (us::ModuleContext *context=us::GetModuleContext())

void	UnregisterService ()

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

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

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

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

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

Protected Member Functions inherited from mitk::AbstractFileWriter
	~AbstractFileWriter () override

	AbstractFileWriter (const AbstractFileWriter &other)

	AbstractFileWriter (const std::string &baseDataType)

	AbstractFileWriter (const std::string &baseDataType, 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)
	Sets a human readable description of this writer. More...

std::string	GetDescription () const

void	SetDefaultOptions (const Options &defaultOptions)

Options	GetDefaultOptions () const

void	SetRanking (int ranking)
	Set the service ranking for this file writer. More...

int	GetRanking () const

void	SetBaseDataType (const std::string &baseDataType)
	Sets the name of the mitk::Basedata that this writer is able to handle. More...

virtual std::string	GetBaseDataType () const

void	ValidateOutputLocation () const

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::IFileWriter
static std::string	PROP_BASEDATA_TYPE ()
	Service property name for the supported mitk::BaseData sub-class. More...

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 28 of file mitkUSDeviceWriterXML.h.

Constructor & Destructor Documentation

◆ USDeviceWriterXML() [1/2]

mitk::USDeviceWriterXML::USDeviceWriterXML ( )

◆ ~USDeviceWriterXML()

mitk::USDeviceWriterXML::~USDeviceWriterXML ( )

override

◆ USDeviceWriterXML() [2/2]

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

protected

Member Function Documentation

◆ Clone()

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

overrideprotectedvirtual

Implements mitk::AbstractFileWriter.

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

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

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

◆ SetFilename()

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

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

◆ Write() [1/2]

void mitk::USDeviceWriterXML::Write ( )

overridevirtual

Write the base data to the specified location or output stream.

This method must be implemented for each specific writer. Call GetOutputStream() first and check for a non-null stream to write to. If the output stream is nullptr, use GetOutputLocation() to write to a local file-system path.

If the reader cannot use streams directly, use GetLocalFile() to retrieve a temporary local file name instead.

Exceptions

mitk::Exception

See also: GetLocalFile(); IFileWriter::Write()

Implements mitk::AbstractFileWriter.

◆ Write() [2/2]

void mitk::AbstractFileWriter::Write

override

Write the base data to the specified location or output stream.

This method must be implemented for each specific writer. Call GetOutputStream() first and check for a non-null stream to write to. If the output stream is nullptr, use GetOutputLocation() to write to a local file-system path.

If the reader cannot use streams directly, use GetLocalFile() to retrieve a temporary local file name instead.

Exceptions

mitk::Exception

See also: GetLocalFile(); IFileWriter::Write()

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

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

mitkUSDeviceWriterXML.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ USDeviceWriterXML() [1/2]

◆ ~USDeviceWriterXML()

◆ USDeviceWriterXML() [2/2]

Member Function Documentation

◆ Clone()

◆ CreateXmlInformationOfGeneralSettingsTag()

◆ CreateXmlInformationOfProbesTag()

◆ CreateXmlInformationOfUltrasoundDeviceTag()

◆ SetFilename()

◆ Write() [1/2]

◆ Write() [2/2]

◆ WriteUltrasoundDeviceConfiguration()