Medical Imaging Interaction Toolkit  2023.12.00
Medical Imaging Interaction Toolkit
mitk::BasePropertySerializer Class Reference

Base class for objects that serialize BaseProperty types. More...

#include <mitkBasePropertySerializer.h>

Inheritance diagram for mitk::BasePropertySerializer:
Collaboration diagram for mitk::BasePropertySerializer:

Public Member Functions

 mitkClassMacroItkParent (BasePropertySerializer, itk::Object)
 
virtual void SetProperty (const BaseProperty *_arg)
 
virtual tinyxml2::XMLElement * Serialize (tinyxml2::XMLDocument &doc)
 Serializes given BaseProperty object. More...
 
virtual BaseProperty::Pointer Deserialize (const tinyxml2::XMLElement *)
 Deserializes given XML element. More...
 

Protected Member Functions

 BasePropertySerializer ()
 
 ~BasePropertySerializer () override
 

Protected Attributes

BaseProperty::ConstPointer m_Property
 

Detailed Description

Base class for objects that serialize BaseProperty types.

The name of sub-classes must be deduced from the class name of the object that should be serialized. The serialization assumes that

If the class derived from BaseProperty is called GreenProperty
Then the serializer for this class must be called GreenPropertySerializer

Definition at line 41 of file mitkBasePropertySerializer.h.

Constructor & Destructor Documentation

◆ BasePropertySerializer()

mitk::BasePropertySerializer::BasePropertySerializer ( )
protected

◆ ~BasePropertySerializer()

mitk::BasePropertySerializer::~BasePropertySerializer ( )
overrideprotected

Member Function Documentation

◆ Deserialize()

virtual BaseProperty::Pointer mitk::BasePropertySerializer::Deserialize ( const tinyxml2::XMLElement *  )
virtual

Deserializes given XML element.

Returns
The deserialized Property.

This should be overwritten by specific sub-classes.

Reimplemented in mitk::VectorPropertySerializer< DATATYPE >, mitk::LookupTablePropertySerializer, mitk::ScalarListLookupTablePropertySerializer, and mitk::TransferFunctionPropertySerializer.

◆ mitkClassMacroItkParent()

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

◆ Serialize()

virtual tinyxml2::XMLElement* mitk::BasePropertySerializer::Serialize ( tinyxml2::XMLDocument &  doc)
virtual

Serializes given BaseProperty object.

Returns
The filename of the newly created file.

This should be overwritten by specific sub-classes.

Reimplemented in mitk::VectorPropertySerializer< DATATYPE >, mitk::LookupTablePropertySerializer, mitk::ScalarListLookupTablePropertySerializer, mitk::TransferFunctionPropertySerializer, and mitk::EnumerationPropertySerializer.

◆ SetProperty()

virtual void mitk::BasePropertySerializer::SetProperty ( const BaseProperty _arg)
virtual

Member Data Documentation

◆ m_Property

BaseProperty::ConstPointer mitk::BasePropertySerializer::m_Property
protected

Definition at line 69 of file mitkBasePropertySerializer.h.


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