Medical Imaging Interaction Toolkit  2023.12.99-63768887
Medical Imaging Interaction Toolkit
mitk::WeakPointerProperty Class Reference

Property containing a smart-pointer. More...

#include <mitkWeakPointerProperty.h>

Inheritance diagram for mitk::WeakPointerProperty:
Collaboration diagram for mitk::WeakPointerProperty:

Public Types

typedef WeakPointerProperty Self
 
typedef BaseProperty Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::WeakPointer< itk::Object > ValueType
 
- Public Types inherited from mitk::BaseProperty
typedef BaseProperty Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
 ~WeakPointerProperty () override
 
ValueType GetWeakPointer () const
 
ValueType GetValue () const
 
void SetWeakPointer (itk::Object *pointer)
 
void SetValue (const ValueType &value)
 
std::string GetValueAsString () const override
 
bool ToJSON (nlohmann::json &j) const override
 Serialize property value(s) to JSON. More...
 
bool FromJSON (const nlohmann::json &j) override
 Deserialize property value(s) from JSON. More...
 
BasePropertyoperator= (const BaseProperty &property)
 Assigns property to this BaseProperty instance. More...
 
- Public Member Functions inherited from mitk::BaseProperty
Pointer Clone () const
 
bool operator== (const BaseProperty &property) const
 Subclasses must implement IsEqual(const BaseProperty&) to support comparison. More...
 
BasePropertyoperator= (const BaseProperty &property)
 Assigns property to this BaseProperty instance. More...
 
bool AssignProperty (const BaseProperty &property)
 Assigns property to this BaseProperty instance. More...
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
static Pointer New (itk::Object *_arg)
 
- Static Public Member Functions inherited from mitk::BaseProperty
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 WeakPointerProperty (const WeakPointerProperty &)
 
 WeakPointerProperty (itk::Object *pointer=nullptr)
 
- Protected Member Functions inherited from mitk::BaseProperty
 BaseProperty ()
 
 BaseProperty (const BaseProperty &other)
 
 ~BaseProperty () override
 

Protected Attributes

itk::WeakPointer< itk::Object > m_WeakPointer
 

Additional Inherited Members

- Static Public Attributes inherited from mitk::BaseProperty
static const std::string VALUE_CANNOT_BE_CONVERTED_TO_STRING
 Default return value if a property which can not be returned as string. More...
 

Detailed Description

Property containing a smart-pointer.

Definition at line 31 of file mitkWeakPointerProperty.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

◆ ValueType

typedef itk::WeakPointer<itk::Object> mitk::WeakPointerProperty::ValueType

Definition at line 43 of file mitkWeakPointerProperty.h.

Constructor & Destructor Documentation

◆ ~WeakPointerProperty()

mitk::WeakPointerProperty::~WeakPointerProperty ( )
override

◆ WeakPointerProperty() [1/2]

mitk::WeakPointerProperty::WeakPointerProperty ( const WeakPointerProperty )
protected

◆ WeakPointerProperty() [2/2]

mitk::WeakPointerProperty::WeakPointerProperty ( itk::Object *  pointer = nullptr)
protected

Member Function Documentation

◆ Clone()

Pointer mitk::WeakPointerProperty::Clone ( ) const

◆ FromJSON()

bool mitk::WeakPointerProperty::FromJSON ( const nlohmann::json j)
overridevirtual

Deserialize property value(s) from JSON.

Rely on exceptions for error handling when implementing deserialization.

Returns
False if not deserializable by design, true otherwise.

Implements mitk::BaseProperty.

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::WeakPointerProperty::GetClassHierarchy ( ) const
inlineoverridevirtual

Reimplemented from mitk::BaseProperty.

Definition at line 34 of file mitkWeakPointerProperty.h.

◆ GetClassName()

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

Reimplemented from mitk::BaseProperty.

◆ GetStaticNameOfClass()

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

Definition at line 34 of file mitkWeakPointerProperty.h.

◆ GetValue()

ValueType mitk::WeakPointerProperty::GetValue ( ) const

◆ GetValueAsString()

std::string mitk::WeakPointerProperty::GetValueAsString ( ) const
overridevirtual

Reimplemented from mitk::BaseProperty.

◆ GetWeakPointer()

ValueType mitk::WeakPointerProperty::GetWeakPointer ( ) const

◆ New() [1/2]

static Pointer mitk::WeakPointerProperty::New ( )
static

◆ New() [2/2]

static Pointer mitk::WeakPointerProperty::New ( itk::Object *  _arg)
inlinestatic

Definition at line 39 of file mitkWeakPointerProperty.h.

◆ operator=()

BaseProperty& mitk::BaseProperty::operator=

Assigns property to this BaseProperty instance.

Subclasses must implement Assign(const BaseProperty&) and call the superclass Assign method for proper handling of polymorphic assignments. The assignment operator of the subclass should be disabled and the baseclass operator should be made visible using "using" statements.

◆ SetValue()

void mitk::WeakPointerProperty::SetValue ( const ValueType value)

◆ SetWeakPointer()

void mitk::WeakPointerProperty::SetWeakPointer ( itk::Object *  pointer)

◆ ToJSON()

bool mitk::WeakPointerProperty::ToJSON ( nlohmann::json j) const
overridevirtual

Serialize property value(s) to JSON.

Rely on exceptions for error handling when implementing serialization.

Returns
False if not serializable by design, true otherwise.

Implements mitk::BaseProperty.

Member Data Documentation

◆ m_WeakPointer

itk::WeakPointer<itk::Object> mitk::WeakPointerProperty::m_WeakPointer
protected

Definition at line 59 of file mitkWeakPointerProperty.h.


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