Property class that wraps an IsoDoseLevelSet for storage in a PropertyList. More...

#include <mitkIsoDoseLevelSetProperty.h>

Inheritance diagram for mitk::IsoDoseLevelSetProperty:

Collaboration diagram for mitk::IsoDoseLevelSetProperty:

[legend]

Public Types
typedef IsoDoseLevelSet	ValueType
	The value type stored by this property. More...

Public Member Functions
	mitkClassMacro (IsoDoseLevelSetProperty, BaseProperty)

	mitkNewMacro1Param (IsoDoseLevelSetProperty, IsoDoseLevelSet *)

	~IsoDoseLevelSetProperty () override
	Destructor. More...

const IsoDoseLevelSet *	GetIsoDoseLevelSet () const
	Get the stored iso dose level set (const version). More...

const IsoDoseLevelSet *	GetValue () const
	Get the stored value (const version). Equivalent to GetIsoDoseLevelSet(). More...

IsoDoseLevelSet *	GetIsoDoseLevelSet ()
	Get the stored iso dose level set (mutable version). More...

IsoDoseLevelSet *	GetValue ()
	Get the stored value (mutable version). Equivalent to GetIsoDoseLevelSet(). More...

void	SetIsoDoseLevelSet (IsoDoseLevelSet *levelSet)
	Set the iso dose level set wrapped by this property. More...

void	SetValue (IsoDoseLevelSet *levelSet)
	Set the value. Equivalent to SetIsoDoseLevelSet(). More...

std::string	GetValueAsString () const override
	Returns a human-readable string representation of the iso dose levels. More...

bool	ToJSON (nlohmann::json &j) const override
	Serialize property to JSON. Currently not implemented. More...

bool	FromJSON (const nlohmann::json &j) override
	Deserialize property from JSON. Currently not implemented. More...

BaseProperty &	operator= (const BaseProperty &property)
	Assign a property value to this instance. More...

Public Member Functions inherited from mitk::BaseProperty
	mitkClassMacroItkParent (BaseProperty, itk::Object)

Pointer	Clone () const

bool	operator== (const BaseProperty &property) const
	Compare two properties for equality. More...

BaseProperty &	operator= (const BaseProperty &property)
	Assign a property value to this instance. More...

bool	AssignProperty (const BaseProperty &property)
	Assign a property value to this instance and report success. More...

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	IsoDoseLevelSetProperty ()
	Default constructor. Creates an empty property. More...

	IsoDoseLevelSetProperty (const IsoDoseLevelSetProperty &other)
	Copy constructor. More...

	IsoDoseLevelSetProperty (IsoDoseLevelSet *levelSet)
	Constructor initializing the property with a given level set. More...

	mitkCloneMacro (IsoDoseLevelSetProperty)

Protected Member Functions inherited from mitk::BaseProperty
	BaseProperty ()

	BaseProperty (const BaseProperty &other)

	~BaseProperty () override

Protected Attributes
IsoDoseLevelSet::Pointer	m_IsoLevelSet
	The wrapped iso dose level set. More...

Additional Inherited Members
Static Public Attributes inherited from mitk::BaseProperty
static const std::string	VALUE_CANNOT_BE_CONVERTED_TO_STRING
	Default return value for properties that cannot be converted to a string. More...

Detailed Description

Property class that wraps an IsoDoseLevelSet for storage in a PropertyList.

This property allows attaching a complete set of iso dose level definitions to a DataNode via the MITK property system. It is typically stored under the key defined by RTConstants::DOSE_ISO_LEVELS_PROPERTY_NAME.

See also: IsoDoseLevelSet; IsoDoseLevelVectorProperty; mitk::BaseProperty

Definition at line 34 of file mitkIsoDoseLevelSetProperty.h.

Member Typedef Documentation

◆ ValueType

typedef IsoDoseLevelSet mitk::IsoDoseLevelSetProperty::ValueType

The value type stored by this property.

Definition at line 62 of file mitkIsoDoseLevelSetProperty.h.

Constructor & Destructor Documentation

◆ IsoDoseLevelSetProperty() [1/3]

mitk::IsoDoseLevelSetProperty::IsoDoseLevelSetProperty ( )

protected

Default constructor. Creates an empty property.

◆ IsoDoseLevelSetProperty() [2/3]

mitk::IsoDoseLevelSetProperty::IsoDoseLevelSetProperty ( const IsoDoseLevelSetProperty & other )

explicitprotected

Copy constructor.

◆ IsoDoseLevelSetProperty() [3/3]

mitk::IsoDoseLevelSetProperty::IsoDoseLevelSetProperty ( IsoDoseLevelSet * levelSet )

explicitprotected

Constructor initializing the property with a given level set.

Parameters

[in] levelSet The iso dose level set to wrap. May be nullptr.

◆ ~IsoDoseLevelSetProperty()

mitk::IsoDoseLevelSetProperty::~IsoDoseLevelSetProperty ( )

override

Destructor.

Member Function Documentation

◆ FromJSON()

bool mitk::IsoDoseLevelSetProperty::FromJSON ( const nlohmann::json & j )

overridevirtual

Deserialize property from JSON. Currently not implemented.

Parameters

[in] j The JSON object to read from.

Returns: Always returns false.

Implements mitk::BaseProperty.

◆ GetIsoDoseLevelSet() [1/2]

IsoDoseLevelSet* mitk::IsoDoseLevelSetProperty::GetIsoDoseLevelSet ( )

Get the stored iso dose level set (mutable version).

Returns: Pointer to the IsoDoseLevelSet, or nullptr if none is set.

◆ GetIsoDoseLevelSet() [2/2]

const IsoDoseLevelSet* mitk::IsoDoseLevelSetProperty::GetIsoDoseLevelSet ( ) const

Get the stored iso dose level set (const version).

Returns: Const pointer to the IsoDoseLevelSet, or nullptr if none is set.

◆ GetValue() [1/2]

IsoDoseLevelSet* mitk::IsoDoseLevelSetProperty::GetValue ( )

Get the stored value (mutable version). Equivalent to GetIsoDoseLevelSet().

Returns: Pointer to the IsoDoseLevelSet, or nullptr if none is set.

◆ GetValue() [2/2]

const IsoDoseLevelSet* mitk::IsoDoseLevelSetProperty::GetValue ( ) const

Get the stored value (const version). Equivalent to GetIsoDoseLevelSet().

Returns: Const pointer to the IsoDoseLevelSet, or nullptr if none is set.

◆ GetValueAsString()

std::string mitk::IsoDoseLevelSetProperty::GetValueAsString ( ) const

overridevirtual

Returns a human-readable string representation of the iso dose levels.

Returns: A string listing the number of levels and their dose values, colors, and visibility.

Reimplemented from mitk::BaseProperty.

◆ mitkClassMacro()

mitk::IsoDoseLevelSetProperty::mitkClassMacro	(	IsoDoseLevelSetProperty	,
		BaseProperty
	)

◆ mitkCloneMacro()

mitk::IsoDoseLevelSetProperty::mitkCloneMacro ( IsoDoseLevelSetProperty )

protected

◆ mitkNewMacro1Param()

mitk::IsoDoseLevelSetProperty::mitkNewMacro1Param	(	IsoDoseLevelSetProperty	,
		IsoDoseLevelSet *
	)

◆ New()

static Pointer mitk::IsoDoseLevelSetProperty::New ( )

static

◆ operator=()

BaseProperty& mitk::BaseProperty::operator=

Assign a property value to this instance.

Performs a polymorphic assignment from the given property. The assignment succeeds only if the source and target properties are of the same type. The subclass-specific Assign() method is called to perform the actual value copy.

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

Parameters

[in] property The property whose value should be assigned to this instance.

Returns: A reference to this property.

See also: AssignProperty; Assign

◆ SetIsoDoseLevelSet()

void mitk::IsoDoseLevelSetProperty::SetIsoDoseLevelSet ( IsoDoseLevelSet * levelSet )

Set the iso dose level set wrapped by this property.

Parameters

[in] levelSet The new iso dose level set. Triggers Modified() if changed.

◆ SetValue()

void mitk::IsoDoseLevelSetProperty::SetValue ( IsoDoseLevelSet * levelSet )

Set the value. Equivalent to SetIsoDoseLevelSet().

Parameters

[in] levelSet The new iso dose level set.

◆ ToJSON()

bool mitk::IsoDoseLevelSetProperty::ToJSON ( nlohmann::json & j ) const

overridevirtual

Serialize property to JSON. Currently not implemented.

Parameters

[out] j The JSON object to write to.

Returns: Always returns false.

Implements mitk::BaseProperty.

Member Data Documentation

◆ m_IsoLevelSet

IsoDoseLevelSet::Pointer mitk::IsoDoseLevelSetProperty::m_IsoLevelSet

protected

The wrapped iso dose level set.

Definition at line 39 of file mitkIsoDoseLevelSetProperty.h.

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

mitkIsoDoseLevelSetProperty.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ValueType

Constructor & Destructor Documentation

◆ IsoDoseLevelSetProperty() [1/3]

◆ IsoDoseLevelSetProperty() [2/3]

◆ IsoDoseLevelSetProperty() [3/3]

◆ ~IsoDoseLevelSetProperty()

Member Function Documentation

◆ FromJSON()

◆ GetIsoDoseLevelSet() [1/2]

◆ GetIsoDoseLevelSet() [2/2]

◆ GetValue() [1/2]

◆ GetValue() [2/2]

◆ GetValueAsString()

◆ mitkClassMacro()

◆ mitkCloneMacro()

◆ mitkNewMacro1Param()

◆ New()

◆ operator=()

◆ SetIsoDoseLevelSet()

◆ SetValue()

◆ ToJSON()

Member Data Documentation

◆ m_IsoLevelSet