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

#include <mitkIsoDoseLevelVectorProperty.h>

Inheritance diagram for mitk::IsoDoseLevelVectorProperty:

Collaboration diagram for mitk::IsoDoseLevelVectorProperty:

[legend]

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

Public Member Functions
	mitkClassMacro (IsoDoseLevelVectorProperty, BaseProperty)

	mitkNewMacro1Param (IsoDoseLevelVectorProperty, IsoDoseLevelVector *)

	~IsoDoseLevelVectorProperty () override
	Destructor. More...

const IsoDoseLevelVector *	GetIsoDoseLevelVector () const
	Get the stored iso dose level vector (const version). More...

const IsoDoseLevelVector *	GetValue () const
	Get the stored value (const version). Equivalent to GetIsoDoseLevelVector(). More...

IsoDoseLevelVector *	GetIsoDoseLevelVector ()
	Get the stored iso dose level vector (mutable version). More...

IsoDoseLevelVector *	GetValue ()
	Get the stored value (mutable version). Equivalent to GetIsoDoseLevelVector(). More...

void	SetIsoDoseLevelVector (IsoDoseLevelVector *levelVector)
	Set the iso dose level vector wrapped by this property. More...

void	SetValue (IsoDoseLevelVector *levelVector)
	Set the value. Equivalent to SetIsoDoseLevelVector(). More...

std::string	GetValueAsString () const override
	Returns a human-readable string representation of the iso dose level vector. 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
	IsoDoseLevelVectorProperty ()
	Default constructor. Creates an empty property. More...

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

	IsoDoseLevelVectorProperty (IsoDoseLevelVector *levelVector)
	Constructor initializing the property with a given level vector. More...

	mitkCloneMacro (IsoDoseLevelVectorProperty)

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

	BaseProperty (const BaseProperty &other)

	~BaseProperty () override

Protected Attributes
IsoDoseLevelVector::Pointer	m_IsoLevelVector
	The wrapped iso dose level vector. 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 IsoDoseLevelVector for storage in a PropertyList.

This property allows attaching an ordered vector of iso dose levels (e.g. user-defined free iso values) to a DataNode via the MITK property system. It is typically stored under the key defined by RTConstants::DOSE_FREE_ISO_VALUES_PROPERTY_NAME.

See also: IsoDoseLevelVector; IsoDoseLevelSetProperty; mitk::BaseProperty

Definition at line 34 of file mitkIsoDoseLevelVectorProperty.h.

Member Typedef Documentation

◆ ValueType

typedef IsoDoseLevelVector mitk::IsoDoseLevelVectorProperty::ValueType

The value type stored by this property.

Definition at line 62 of file mitkIsoDoseLevelVectorProperty.h.

Constructor & Destructor Documentation

◆ IsoDoseLevelVectorProperty() [1/3]

mitk::IsoDoseLevelVectorProperty::IsoDoseLevelVectorProperty ( )

protected

Default constructor. Creates an empty property.

◆ IsoDoseLevelVectorProperty() [2/3]

mitk::IsoDoseLevelVectorProperty::IsoDoseLevelVectorProperty ( const IsoDoseLevelVectorProperty & other )

explicitprotected

Copy constructor.

◆ IsoDoseLevelVectorProperty() [3/3]

mitk::IsoDoseLevelVectorProperty::IsoDoseLevelVectorProperty ( IsoDoseLevelVector * levelVector )

explicitprotected

Constructor initializing the property with a given level vector.

Parameters

[in] levelVector The iso dose level vector to wrap. May be nullptr.

◆ ~IsoDoseLevelVectorProperty()

mitk::IsoDoseLevelVectorProperty::~IsoDoseLevelVectorProperty ( )

override

Destructor.

Member Function Documentation

◆ FromJSON()

bool mitk::IsoDoseLevelVectorProperty::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.

◆ GetIsoDoseLevelVector() [1/2]

IsoDoseLevelVector* mitk::IsoDoseLevelVectorProperty::GetIsoDoseLevelVector ( )

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

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

◆ GetIsoDoseLevelVector() [2/2]

const IsoDoseLevelVector* mitk::IsoDoseLevelVectorProperty::GetIsoDoseLevelVector ( ) const

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

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

◆ GetValue() [1/2]

IsoDoseLevelVector* mitk::IsoDoseLevelVectorProperty::GetValue ( )

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

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

◆ GetValue() [2/2]

const IsoDoseLevelVector* mitk::IsoDoseLevelVectorProperty::GetValue ( ) const

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

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

◆ GetValueAsString()

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

overridevirtual

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

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

Reimplemented from mitk::BaseProperty.

◆ mitkClassMacro()

mitk::IsoDoseLevelVectorProperty::mitkClassMacro	(	IsoDoseLevelVectorProperty	,
		BaseProperty
	)

◆ mitkCloneMacro()

mitk::IsoDoseLevelVectorProperty::mitkCloneMacro ( IsoDoseLevelVectorProperty )

protected

◆ mitkNewMacro1Param()

mitk::IsoDoseLevelVectorProperty::mitkNewMacro1Param	(	IsoDoseLevelVectorProperty	,
		IsoDoseLevelVector *
	)

◆ New()

static Pointer mitk::IsoDoseLevelVectorProperty::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

◆ SetIsoDoseLevelVector()

void mitk::IsoDoseLevelVectorProperty::SetIsoDoseLevelVector ( IsoDoseLevelVector * levelVector )

Set the iso dose level vector wrapped by this property.

Parameters

[in] levelVector The new iso dose level vector. Triggers Modified() if changed.

◆ SetValue()

void mitk::IsoDoseLevelVectorProperty::SetValue ( IsoDoseLevelVector * levelVector )

Set the value. Equivalent to SetIsoDoseLevelVector().

Parameters

[in] levelVector The new iso dose level vector.

◆ ToJSON()

bool mitk::IsoDoseLevelVectorProperty::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_IsoLevelVector

IsoDoseLevelVector::Pointer mitk::IsoDoseLevelVectorProperty::m_IsoLevelVector

protected

The wrapped iso dose level vector.

Definition at line 39 of file mitkIsoDoseLevelVectorProperty.h.

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

mitkIsoDoseLevelVectorProperty.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

◆ IsoDoseLevelVectorProperty() [1/3]

◆ IsoDoseLevelVectorProperty() [2/3]

◆ IsoDoseLevelVectorProperty() [3/3]

◆ ~IsoDoseLevelVectorProperty()

Member Function Documentation

◆ FromJSON()

◆ GetIsoDoseLevelVector() [1/2]

◆ GetIsoDoseLevelVector() [2/2]

◆ GetValue() [1/2]

◆ GetValue() [2/2]

◆ GetValueAsString()

◆ mitkClassMacro()

◆ mitkCloneMacro()

◆ mitkNewMacro1Param()

◆ New()

◆ operator=()

◆ SetIsoDoseLevelVector()

◆ SetValue()

◆ ToJSON()

Member Data Documentation

◆ m_IsoLevelVector