Medical Imaging Interaction Toolkit  2024.06.99-60d9b802
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
mitk::ModalityProperty Class Reference

Enumerates all known modalities. More...

#include <mitkModalityProperty.h>

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

Public Types

typedef ModalityProperty Self
 
typedef EnumerationProperty Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
- Public Types inherited from mitk::EnumerationProperty
typedef EnumerationProperty Self
 
typedef BaseProperty Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef unsigned int IdType
 
typedef std::map< IdType, std::string > EnumIdsContainerType
 
typedef std::map< std::string, IdType > EnumStringsContainerType
 
typedef EnumIdsContainerType::const_iterator EnumConstIterator
 
- Public Types inherited from mitk::BaseProperty
typedef BaseProperty Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
BaseProperty & operator= (const BaseProperty &property)
 Assigns property to this BaseProperty instance. More...
 
- Public Member Functions inherited from mitk::EnumerationProperty
Pointer Clone () const
 
virtual bool AddEnum (const std::string &name, const IdType &id)
 
virtual bool SetValue (const std::string &name)
 
virtual bool SetValue (const IdType &id)
 
virtual IdType GetValueAsId () const
 
std::string GetValueAsString () const override
 
virtual void Clear ()
 
virtual EnumIdsContainerType::size_type Size () const
 
virtual EnumConstIterator Begin () const
 
virtual EnumConstIterator End () const
 
virtual std::string GetEnumString (const IdType &id) const
 
virtual IdType GetEnumId (const std::string &name) const
 
virtual bool IsValidEnumerationValue (const IdType &id) const
 
virtual bool IsValidEnumerationValue (const std::string &name) const
 
const EnumIdsContainerType & GetEnumIds () const
 
const EnumStringsContainerType & GetEnumStrings () const
 
EnumIdsContainerType & GetEnumIds ()
 
EnumStringsContainerType & GetEnumStrings ()
 
bool ToJSON (nlohmann::json &j) const override
 
bool FromJSON (const nlohmann::json &j) override
 
EnumerationProperty & operator= (const EnumerationProperty &)=delete
 
BaseProperty & operator= (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...
 
BaseProperty & operator= (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 IdType &_arg)
 
static Pointer New (const std::string &_arg)
 
- Static Public Member Functions inherited from mitk::EnumerationProperty
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::BaseProperty
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 ModalityProperty ()
 
 ModalityProperty (const IdType &value)
 
 ModalityProperty (const std::string &value)
 
 ~ModalityProperty () override
 
virtual void AddEnumerationTypes ()
 
- Protected Member Functions inherited from mitk::EnumerationProperty
 EnumerationProperty ()
 
 EnumerationProperty (const EnumerationProperty &)
 
bool IsEqual (const BaseProperty &property) const override
 
bool Assign (const BaseProperty &property) override
 
- Protected Member Functions inherited from mitk::BaseProperty
 BaseProperty ()
 
 BaseProperty (const BaseProperty &other)
 
 ~BaseProperty () override
 

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

Enumerates all known modalities.

Definition at line 32 of file mitkModalityProperty.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 35 of file mitkModalityProperty.h.

◆ Pointer

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

Definition at line 35 of file mitkModalityProperty.h.

◆ Self

typedef ModalityProperty mitk::ModalityProperty::Self

Definition at line 35 of file mitkModalityProperty.h.

◆ Superclass

typedef EnumerationProperty mitk::ModalityProperty::Superclass

Definition at line 35 of file mitkModalityProperty.h.

Constructor & Destructor Documentation

◆ ModalityProperty() [1/3]

mitk::ModalityProperty::ModalityProperty ( )
protected

◆ ModalityProperty() [2/3]

mitk::ModalityProperty::ModalityProperty ( const IdType &  value)
protected

◆ ModalityProperty() [3/3]

mitk::ModalityProperty::ModalityProperty ( const std::string &  value)
protected

◆ ~ModalityProperty()

mitk::ModalityProperty::~ModalityProperty ( )
overrideprotected

Member Function Documentation

◆ AddEnumerationTypes()

virtual void mitk::ModalityProperty::AddEnumerationTypes ( )
protectedvirtual

◆ Clone()

Pointer mitk::ModalityProperty::Clone ( ) const

◆ GetClassHierarchy()

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

Reimplemented from mitk::EnumerationProperty.

Definition at line 35 of file mitkModalityProperty.h.

◆ GetClassName()

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

Reimplemented from mitk::EnumerationProperty.

◆ GetStaticNameOfClass()

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

Definition at line 35 of file mitkModalityProperty.h.

◆ New() [1/3]

static Pointer mitk::ModalityProperty::New ( )
static

◆ New() [2/3]

static Pointer mitk::ModalityProperty::New ( const IdType &  _arg)
inlinestatic

Definition at line 38 of file mitkModalityProperty.h.

◆ New() [3/3]

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

Definition at line 39 of file mitkModalityProperty.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.

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