Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
mitk::LevelWindowProperty Class Reference

The LevelWindowProperty class Property for the mitk::LevelWindow. More...

#include <mitkLevelWindowProperty.h>

Inheritance diagram for mitk::LevelWindowProperty:
Collaboration diagram for mitk::LevelWindowProperty:

Public Types

typedef LevelWindowProperty Self
 
typedef BaseProperty Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef LevelWindow 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
 
 ~LevelWindowProperty () override
 
const mitk::LevelWindowGetLevelWindow () const
 
const mitk::LevelWindowGetValue () const
 
void SetLevelWindow (const LevelWindow &levWin)
 
void SetValue (const ValueType &levWin)
 
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 (const mitk::LevelWindow &_arg)
 
- Static Public Member Functions inherited from mitk::BaseProperty
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 LevelWindowProperty ()
 
 LevelWindowProperty (const LevelWindowProperty &other)
 
 LevelWindowProperty (const mitk::LevelWindow &levWin)
 
- Protected Member Functions inherited from mitk::BaseProperty
 BaseProperty ()
 
 BaseProperty (const BaseProperty &other)
 
 ~BaseProperty () override
 

Protected Attributes

LevelWindow m_LevWin
 

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

The LevelWindowProperty class Property for the mitk::LevelWindow.

Note
If you want to apply the mitk::LevelWindowProperty to an mitk::Image, make sure to set the mitk::RenderingModeProperty to a mode which supports level window (e.g. LEVELWINDOW_COLOR). Make sure to check the documentation of the mitk::RenderingModeProperty. For a code example how to use the mitk::LevelWindowProperty check the mitkImageVtkMapper2DLevelWindowTest.cpp in Core/Code/Testing.

Definition at line 37 of file mitkLevelWindowProperty.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

◆ ValueType

Constructor & Destructor Documentation

◆ LevelWindowProperty() [1/3]

mitk::LevelWindowProperty::LevelWindowProperty ( )
protected

◆ LevelWindowProperty() [2/3]

mitk::LevelWindowProperty::LevelWindowProperty ( const LevelWindowProperty other)
protected

◆ LevelWindowProperty() [3/3]

mitk::LevelWindowProperty::LevelWindowProperty ( const mitk::LevelWindow levWin)
protected

◆ ~LevelWindowProperty()

mitk::LevelWindowProperty::~LevelWindowProperty ( )
override

Member Function Documentation

◆ Clone()

Pointer mitk::LevelWindowProperty::Clone ( ) const

◆ FromJSON()

bool mitk::LevelWindowProperty::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::LevelWindowProperty::GetClassHierarchy ( ) const
inlineoverridevirtual

Reimplemented from mitk::BaseProperty.

Definition at line 49 of file mitkLevelWindowProperty.h.

◆ GetClassName()

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

Reimplemented from mitk::BaseProperty.

◆ GetLevelWindow()

const mitk::LevelWindow& mitk::LevelWindowProperty::GetLevelWindow ( ) const

◆ GetStaticNameOfClass()

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

Definition at line 49 of file mitkLevelWindowProperty.h.

◆ GetValue()

const mitk::LevelWindow& mitk::LevelWindowProperty::GetValue ( ) const

◆ GetValueAsString()

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

Reimplemented from mitk::BaseProperty.

◆ New() [1/2]

static Pointer mitk::LevelWindowProperty::New ( )
static

◆ New() [2/2]

static Pointer mitk::LevelWindowProperty::New ( const mitk::LevelWindow _arg)
inlinestatic

Definition at line 53 of file mitkLevelWindowProperty.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.

◆ SetLevelWindow()

void mitk::LevelWindowProperty::SetLevelWindow ( const LevelWindow levWin)

◆ SetValue()

void mitk::LevelWindowProperty::SetValue ( const ValueType levWin)

◆ ToJSON()

bool mitk::LevelWindowProperty::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_LevWin

LevelWindow mitk::LevelWindowProperty::m_LevWin
protected

Definition at line 40 of file mitkLevelWindowProperty.h.


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