Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
mitk::PropertyPersistenceInfo Class Reference

Property persistence info. This class is used to specify the way the persistance of a property of BaseData derived instances is handled. The info specifies the key for property, as well as the mime type the info is defined for and should be used. Additionally the functions for deserialization and serialization of the property can be defined. As default. More...

#include <mitkPropertyPersistenceInfo.h>

Inheritance diagram for mitk::PropertyPersistenceInfo:
Inheritance graph
[legend]
Collaboration diagram for mitk::PropertyPersistenceInfo:
Collaboration graph
[legend]

Public Types

using DeserializationFunctionType = std::function< mitk::BaseProperty::Pointer(const std::string &)>
 
using SerializationFunctionType = std::function< std::string(const mitk::BaseProperty *)>
 
using MimeTypeNameType = std::string
 
typedef PropertyPersistenceInfo Self
 
typedef itk::LightObject Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
std::string GetName () const
 
std::string GetKey () const
 
void SetName (const std::string &name)
 
void SetNameAndKey (const std::string &name, const std::string &key)
 
bool IsRegEx () const
 
void UseRegEx (const std::string &nameRegEx, const std::string &nameTemplate)
 
void UseRegEx (const std::string &nameRegEx, const std::string &nameTemplate, const std::string &keyRegEx, const std::string keyTemplate)
 
const std::string & GetKeyTemplate () const
 
const std::string & GetNameTemplate () const
 
const MimeTypeNameType & GetMimeTypeName () const
 
void SetMimeTypeName (const MimeTypeNameType &mimeTypeName)
 
const DeserializationFunctionType GetDeserializationFunction () const
 
void SetDeserializationFunction (const DeserializationFunctionType &fnc)
 
const SerializationFunctionType GetSerializationFunction () const
 
void SetSerializationFunction (const SerializationFunctionType &fnc)
 
PropertyPersistenceInfo::Pointer UnRegExByName (const std::string &propertyName) const
 
PropertyPersistenceInfo::Pointer UnRegExByKey (const std::string &key) const
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
static Pointer New (const std::string &_arg)
 
static Pointer New (const std::string &_arga, const std::string &_argb)
 
static MimeTypeNameType ANY_MIMETYPE_NAME ()
 

Protected Member Functions

 PropertyPersistenceInfo (const std::string &name="")
 Constructor. More...
 
 PropertyPersistenceInfo (const std::string &name, const std::string &mimeTypeName)
 Constructor. More...
 
 ~PropertyPersistenceInfo () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 

Detailed Description

Property persistence info. This class is used to specify the way the persistance of a property of BaseData derived instances is handled. The info specifies the key for property, as well as the mime type the info is defined for and should be used. Additionally the functions for deserialization and serialization of the property can be defined. As default.

Definition at line 32 of file mitkPropertyPersistenceInfo.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer<const Self> mitk::PropertyPersistenceInfo::ConstPointer

Definition at line 39 of file mitkPropertyPersistenceInfo.h.

◆ DeserializationFunctionType

using mitk::PropertyPersistenceInfo::DeserializationFunctionType = std::function<mitk::BaseProperty::Pointer(const std::string &)>

Definition at line 35 of file mitkPropertyPersistenceInfo.h.

◆ MimeTypeNameType

using mitk::PropertyPersistenceInfo::MimeTypeNameType = std::string

Definition at line 37 of file mitkPropertyPersistenceInfo.h.

◆ Pointer

typedef itk::SmartPointer<Self> mitk::PropertyPersistenceInfo::Pointer

Definition at line 39 of file mitkPropertyPersistenceInfo.h.

◆ Self

typedef PropertyPersistenceInfo mitk::PropertyPersistenceInfo::Self

Definition at line 39 of file mitkPropertyPersistenceInfo.h.

◆ SerializationFunctionType

using mitk::PropertyPersistenceInfo::SerializationFunctionType = std::function<std::string(const mitk::BaseProperty *)>

Definition at line 36 of file mitkPropertyPersistenceInfo.h.

◆ Superclass

typedef itk::LightObject mitk::PropertyPersistenceInfo::Superclass

Definition at line 39 of file mitkPropertyPersistenceInfo.h.

Constructor & Destructor Documentation

◆ PropertyPersistenceInfo() [1/2]

mitk::PropertyPersistenceInfo::PropertyPersistenceInfo ( const std::string &  name = "")
protected

Constructor.

Parameters
[in]nameName is the name of the property that described by the info. Key will be the same.

Definition at line 50 of file mitkPropertyPersistenceInfo.cpp.

◆ PropertyPersistenceInfo() [2/2]

mitk::PropertyPersistenceInfo::PropertyPersistenceInfo ( const std::string &  name,
const std::string &  mimeTypeName 
)
protected

Constructor.

Parameters
[in]nameName is the name of the property that described by the info. Key will be the same.
[in]mimeTypeNamemime type the info is defined for.

Definition at line 56 of file mitkPropertyPersistenceInfo.cpp.

◆ ~PropertyPersistenceInfo()

mitk::PropertyPersistenceInfo::~PropertyPersistenceInfo ( )
overrideprotected

Definition at line 64 of file mitkPropertyPersistenceInfo.cpp.

Member Function Documentation

◆ ANY_MIMETYPE_NAME()

mitk::PropertyPersistenceInfo::MimeTypeNameType mitk::PropertyPersistenceInfo::ANY_MIMETYPE_NAME ( )
static

This mime type name indicates that a info can be used for any mime type as long as another info with a more specific mime type is not available.

Definition at line 225 of file mitkPropertyPersistenceInfo.cpp.

References mitk::IOMimeTypes::DEFAULT_BASE_NAME().

Referenced by mitk::PropertyPersistence::GetInfo(), mitk::ItkImageIO::Read(), and testDeserializeFunction().

◆ Clone()

Pointer mitk::PropertyPersistenceInfo::Clone ( ) const

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::PropertyPersistenceInfo::GetClassHierarchy ( ) const
inlinevirtual

Definition at line 39 of file mitkPropertyPersistenceInfo.h.

◆ GetClassName()

virtual const char* mitk::PropertyPersistenceInfo::GetClassName ( ) const
virtual

◆ GetDeserializationFunction()

const mitk::PropertyPersistenceInfo::DeserializationFunctionType mitk::PropertyPersistenceInfo::GetDeserializationFunction ( ) const

Definition at line 147 of file mitkPropertyPersistenceInfo.cpp.

◆ GetKey()

std::string mitk::PropertyPersistenceInfo::GetKey ( ) const

Definition at line 74 of file mitkPropertyPersistenceInfo.cpp.

Referenced by UnRegExByKey().

◆ GetKeyTemplate()

const std::string & mitk::PropertyPersistenceInfo::GetKeyTemplate ( ) const

Definition at line 126 of file mitkPropertyPersistenceInfo.cpp.

Referenced by UnRegExByName().

◆ GetMimeTypeName()

const mitk::PropertyPersistenceInfo::MimeTypeNameType & mitk::PropertyPersistenceInfo::GetMimeTypeName ( ) const

Definition at line 136 of file mitkPropertyPersistenceInfo.cpp.

Referenced by mitk::PropertyPersistence::AddInfo().

◆ GetName()

std::string mitk::PropertyPersistenceInfo::GetName ( ) const

Definition at line 69 of file mitkPropertyPersistenceInfo.cpp.

Referenced by mitk::PropertyPersistence::AddInfo(), and UnRegExByName().

◆ GetNameTemplate()

const std::string & mitk::PropertyPersistenceInfo::GetNameTemplate ( ) const

Definition at line 131 of file mitkPropertyPersistenceInfo.cpp.

Referenced by UnRegExByKey().

◆ GetSerializationFunction()

const mitk::PropertyPersistenceInfo::SerializationFunctionType mitk::PropertyPersistenceInfo::GetSerializationFunction ( ) const

Definition at line 158 of file mitkPropertyPersistenceInfo.cpp.

◆ GetStaticNameOfClass()

static const char* mitk::PropertyPersistenceInfo::GetStaticNameOfClass ( )
inlinestatic

Definition at line 39 of file mitkPropertyPersistenceInfo.h.

◆ IsRegEx()

bool mitk::PropertyPersistenceInfo::IsRegEx ( ) const

Definition at line 121 of file mitkPropertyPersistenceInfo.cpp.

Referenced by UnRegExByKey(), and UnRegExByName().

◆ New() [1/3]

static Pointer mitk::PropertyPersistenceInfo::New ( )
static

Referenced by mitk::pa::InSilicoTissueVolume::AddDoubleProperty(), mitk::pa::InSilicoTissueVolume::AddIntProperty(), mitk::DICOMTagsOfInterestService::AddTagOfInterest(), main(), mitk::CustomTagParser::ParseDicomPropertyString(), mitk::ItkImageIO::Read(), testDeserializeFunction(), UnRegExByKey(), and UnRegExByName().

◆ New() [2/3]

static Pointer mitk::PropertyPersistenceInfo::New ( const std::string &  _arg)
inlinestatic

Definition at line 41 of file mitkPropertyPersistenceInfo.h.

◆ New() [3/3]

static Pointer mitk::PropertyPersistenceInfo::New ( const std::string &  _arga,
const std::string &  _argb 
)
inlinestatic

Definition at line 42 of file mitkPropertyPersistenceInfo.h.

◆ PrintSelf()

void mitk::PropertyPersistenceInfo::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Definition at line 231 of file mitkPropertyPersistenceInfo.cpp.

◆ SetDeserializationFunction()

void mitk::PropertyPersistenceInfo::SetDeserializationFunction ( const DeserializationFunctionType &  fnc)

Definition at line 152 of file mitkPropertyPersistenceInfo.cpp.

◆ SetMimeTypeName()

void mitk::PropertyPersistenceInfo::SetMimeTypeName ( const MimeTypeNameType &  mimeTypeName)

Definition at line 141 of file mitkPropertyPersistenceInfo.cpp.

◆ SetName()

void mitk::PropertyPersistenceInfo::SetName ( const std::string &  name)

Definition at line 79 of file mitkPropertyPersistenceInfo.cpp.

◆ SetNameAndKey()

void mitk::PropertyPersistenceInfo::SetNameAndKey ( const std::string &  name,
const std::string &  key 
)

Definition at line 88 of file mitkPropertyPersistenceInfo.cpp.

◆ SetSerializationFunction()

void mitk::PropertyPersistenceInfo::SetSerializationFunction ( const SerializationFunctionType &  fnc)

Definition at line 164 of file mitkPropertyPersistenceInfo.cpp.

◆ UnRegExByKey()

mitk::PropertyPersistenceInfo::Pointer mitk::PropertyPersistenceInfo::UnRegExByKey ( const std::string &  key) const

Definition at line 211 of file mitkPropertyPersistenceInfo.cpp.

References GenerateFromTemplate(), GetKey(), GetNameTemplate(), IsRegEx(), and New().

◆ UnRegExByName()

mitk::PropertyPersistenceInfo::Pointer mitk::PropertyPersistenceInfo::UnRegExByName ( const std::string &  propertyName) const

Definition at line 196 of file mitkPropertyPersistenceInfo.cpp.

References GenerateFromTemplate(), GetKeyTemplate(), GetName(), IsRegEx(), and New().

◆ UseRegEx() [1/2]

void mitk::PropertyPersistenceInfo::UseRegEx ( const std::string &  nameRegEx,
const std::string &  nameTemplate 
)

Sets the name and the key identifier as a regular expression that describes valid names and keys.

Precondition
nameRegEx must be a valid regular expression, otherweis a regex_error esception is thrown and the info object is not changed.
keyRegEx must be a valid regular expression, otherweis a regex_error esception is thrown and the info object is not changed.

Definition at line 97 of file mitkPropertyPersistenceInfo.cpp.

◆ UseRegEx() [2/2]

void mitk::PropertyPersistenceInfo::UseRegEx ( const std::string &  nameRegEx,
const std::string &  nameTemplate,
const std::string &  keyRegEx,
const std::string  keyTemplate 
)

Definition at line 107 of file mitkPropertyPersistenceInfo.cpp.

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