Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::ExampleDataStructureSerializer Class Reference

Serializes mitk::ExampleDataStructure for mitk::SceneIO. More...

#include <mitkExampleDataStructureSerializer.h>

Inheritance diagram for mitk::ExampleDataStructureSerializer:
Collaboration diagram for mitk::ExampleDataStructureSerializer:

Public Member Functions

 mitkClassMacro (ExampleDataStructureSerializer, BaseDataSerializer)
 
Pointer Clone () const
 
std::string Serialize () override
 Serializes the previously set BaseData object to a file. More...
 
- Public Member Functions inherited from mitk::BaseDataSerializer
 mitkClassMacroItkParent (BaseDataSerializer, itk::Object)
 
virtual void SetFilenameHint (const char *_arg)
 Sets a hint for the output filename (without path or extension). More...
 
virtual const char * GetFilenameHint () const
 Returns the current filename hint. More...
 
virtual void SetWorkingDirectory (const char *_arg)
 Sets the working directory where serialized files will be stored. More...
 
virtual const char * GetWorkingDirectory () const
 Returns the current working directory for serialized files. More...
 
virtual void SetData (const BaseData *_arg)
 Sets the BaseData object to be serialized. More...
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 ExampleDataStructureSerializer ()
 
 ~ExampleDataStructureSerializer () override
 
- Protected Member Functions inherited from mitk::BaseDataSerializer
 BaseDataSerializer ()
 
 ~BaseDataSerializer () override
 
std::string GetUniqueFilenameInWorkingDirectory ()
 

Additional Inherited Members

- Protected Attributes inherited from mitk::BaseDataSerializer
std::string m_FilenameHint
 
std::string m_WorkingDirectory
 
BaseData::ConstPointer m_Data
 

Detailed Description

Constructor & Destructor Documentation

◆ ExampleDataStructureSerializer()

mitk::ExampleDataStructureSerializer::ExampleDataStructureSerializer ( )
protected

◆ ~ExampleDataStructureSerializer()

mitk::ExampleDataStructureSerializer::~ExampleDataStructureSerializer ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::ExampleDataStructureSerializer::Clone ( ) const

◆ mitkClassMacro()

mitk::ExampleDataStructureSerializer::mitkClassMacro ( ExampleDataStructureSerializer  ,
BaseDataSerializer   
)

◆ New()

static Pointer mitk::ExampleDataStructureSerializer::New ( )
static

◆ Serialize()

std::string mitk::ExampleDataStructureSerializer::Serialize ( )
overridevirtual

Serializes the previously set BaseData object to a file.

The base implementation logs the request and returns an empty string. Sub-classes must override this method to perform the actual serialization, writing data to a file in the working directory.

Returns
The filename (without path) of the newly created file, or an empty string if serialization failed or is not implemented.
Precondition
The Data object must be set via SetData().
The WorkingDirectory must be set via SetWorkingDirectory().

Reimplemented from mitk::BaseDataSerializer.


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