mitk::PropertyListDeserializer Class Reference

Deserializes a mitk::PropertyList from an XML file. More...

#include <mitkPropertyListDeserializer.h>

Inheritance diagram for mitk::PropertyListDeserializer:

Collaboration diagram for mitk::PropertyListDeserializer:

Public Member Functions
	mitkClassMacroItkParent (PropertyListDeserializer, itk::Object)
Pointer	Clone () const
virtual void	SetFilename (const char *_arg)
	Set the filename of the XML file to deserialize. More...
virtual const char *	GetFilename () const
	Get the filename of the XML file to deserialize. More...
virtual bool	Deserialize ()
	Read a PropertyList from the configured XML file. More...
virtual PropertyList::Pointer	GetOutput ()
	Retrieve the deserialized PropertyList. More...

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	PropertyListDeserializer ()
	~PropertyListDeserializer () override

Protected Attributes
std::string	m_Filename
	Path to the XML file to deserialize. More...
PropertyList::Pointer	m_PropertyList
	The deserialized property list. More...

Detailed Description

Deserializes a mitk::PropertyList from an XML file.

Acts as a version-dispatching base class for property list deserialization. When Deserialize() is called, it reads the file version from the XML document and instantiates the appropriate versioned deserializer (e.g., PropertyListDeserializerV1) through the ITK object factory mechanism. The deserialized PropertyList can then be retrieved via GetOutput().

See also

PropertyListDeserializerV1, PropertyListSerializer, SceneIO

Definition at line 31 of file mitkPropertyListDeserializer.h.

Constructor & Destructor Documentation

PropertyListDeserializer()

mitk::PropertyListDeserializer::PropertyListDeserializer ( )

protected

~PropertyListDeserializer()

mitk::PropertyListDeserializer::~PropertyListDeserializer ( )

overrideprotected

Member Function Documentation

Clone()

Pointer mitk::PropertyListDeserializer::Clone

(

)

const

Deserialize()

virtual bool mitk::PropertyListDeserializer::Deserialize ( )

virtual

Read a PropertyList from the configured XML file.

Parses the file to determine its version, then delegates to the appropriate versioned deserializer found via the ITK object factory. The result can be retrieved with GetOutput().

Returns

True if deserialization succeeded, false otherwise.

Precondition

The Filename must be set to a valid XML file path.

Reimplemented in mitk::PropertyListDeserializerV1.

GetFilename()

virtual const char* mitk::PropertyListDeserializer::GetFilename ( ) const

virtual

Get the filename of the XML file to deserialize.

GetOutput()

virtual PropertyList::Pointer mitk::PropertyListDeserializer::GetOutput ( )

virtual

Retrieve the deserialized PropertyList.

Returns

The PropertyList read from the file, or nullptr if Deserialize() has not been called or failed.

mitkClassMacroItkParent()

mitk::PropertyListDeserializer::mitkClassMacroItkParent	(	PropertyListDeserializer	,
		itk::Object
	)

New()

static Pointer mitk::PropertyListDeserializer::New ( )

static

SetFilename()

virtual void mitk::PropertyListDeserializer::SetFilename ( const char *  _arg )

virtual

Set the filename of the XML file to deserialize.

Member Data Documentation

m_Filename

std::string mitk::PropertyListDeserializer::m_Filename

protected

Path to the XML file to deserialize.

Definition at line 68 of file mitkPropertyListDeserializer.h.

m_PropertyList

PropertyList::Pointer mitk::PropertyListDeserializer::m_PropertyList

protected

The deserialized property list.

Definition at line 69 of file mitkPropertyListDeserializer.h.

---

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

• mitkPropertyListDeserializer.h