Medical Imaging Interaction Toolkit  2018.4.99-064ad45c
Medical Imaging Interaction Toolkit
mitk::BaseProperty Class Referenceabstract

Abstract base class for properties. More...

#include <mitkBaseProperty.h>

Inheritance diagram for mitk::BaseProperty:
Collaboration diagram for mitk::BaseProperty:

Public Types

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
 
virtual const char * GetClassName () const
 
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...
 
virtual std::string GetValueAsString () const
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 

Static Public Attributes

static const std::string VALUE_CANNOT_BE_CONVERTED_TO_STRING
 Default return value if a property which can not be returned as string. More...
 

Protected Member Functions

 BaseProperty ()
 
 BaseProperty (const BaseProperty &other)
 
 ~BaseProperty () override
 

Detailed Description

Abstract base class for properties.

Base class for properties. Properties are arbitrary additional information (to define a new type of information you have to define a subclass of BaseProperty) that can be added to a PropertyList. Concrete subclasses of BaseProperty should define Set-/Get-methods to assess the property value, which should be stored by value (not by reference). Subclasses must implement an operator==(const BaseProperty& property), which is used by PropertyList to check whether a property has been changed.

Definition at line 35 of file mitkBaseProperty.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 38 of file mitkBaseProperty.h.

◆ Pointer

◆ Self

Definition at line 38 of file mitkBaseProperty.h.

◆ Superclass

typedef itk::Object mitk::BaseProperty::Superclass

Definition at line 38 of file mitkBaseProperty.h.

Constructor & Destructor Documentation

◆ BaseProperty() [1/2]

mitk::BaseProperty::BaseProperty ( )
protected

Definition at line 17 of file mitkBaseProperty.cpp.

◆ BaseProperty() [2/2]

mitk::BaseProperty::BaseProperty ( const BaseProperty other)
protected

Definition at line 21 of file mitkBaseProperty.cpp.

◆ ~BaseProperty()

mitk::BaseProperty::~BaseProperty ( )
overrideprotected

Definition at line 25 of file mitkBaseProperty.cpp.

Member Function Documentation

◆ AssignProperty()

bool mitk::BaseProperty::AssignProperty ( const BaseProperty property)

Assigns property to this BaseProperty instance.

This method is identical to the assignment operator, except for the return type. It allows to directly check if the assignemnt was successfull.

Definition at line 40 of file mitkBaseProperty.cpp.

Referenced by operator=().

◆ Clone()

Pointer mitk::BaseProperty::Clone ( ) const

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::BaseProperty::GetClassHierarchy ( ) const
inlinevirtual

Reimplemented in mitk::RenderingModeProperty, mitk::VectorProperty< DATATYPE >, mitk::ColorProperty, mitk::LookupTableProperty, mitk::LevelWindowProperty, mitk::GenericProperty< T >, mitk::GenericProperty< Point4D >, mitk::GenericProperty< double >, mitk::GenericProperty< IntLookupTable >, mitk::GenericProperty< float >, mitk::GenericProperty< Point3I >, mitk::GenericProperty< int >, mitk::GenericProperty< FloatLookupTable >, mitk::GenericProperty< unsigned int >, mitk::GenericProperty< unsigned short >, mitk::GenericProperty< Vector3D >, mitk::GenericProperty< BoolLookupTable >, mitk::GenericProperty< Point2D >, mitk::GenericProperty< Point3D >, mitk::GenericProperty< bool >, mitk::GenericProperty< StringLookupTable >, mitk::PointSetShapeProperty, mitk::StringLookupTableProperty, mitk::EnumerationProperty, mitk::IntLookupTableProperty, mitk::BoolLookupTableProperty, mitk::StringProperty, mitk::FloatLookupTableProperty, mitk::Point3iProperty, mitk::TemporoSpatialStringProperty, mitk::PlaneOrientationProperty, mitk::TransferFunctionProperty, mitk::Point4dProperty, mitk::ClippingProperty, mitk::Point3dProperty, mitk::SmartPointerProperty, mitk::VtkScalarModeProperty, mitk::VtkVolumeRenderingProperty, mitk::GroupTagProperty, mitk::Point2dProperty, mitk::VtkResliceInterpolationProperty, mitk::ModalityProperty, mitk::Vector3DProperty, mitk::VtkInterpolationProperty, mitk::VtkRepresentationProperty, mitk::WeakPointerProperty, mitk::AnnotationProperty, mitk::DoubleProperty, mitk::ResliceMethodProperty, mitk::FloatProperty, mitk::UShortProperty, mitk::UIntProperty, mitk::IntProperty, and mitk::BoolProperty.

Definition at line 38 of file mitkBaseProperty.h.

◆ GetClassName()

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

Reimplemented in mitk::RenderingModeProperty, mitk::ColorProperty, mitk::LookupTableProperty, mitk::LevelWindowProperty, mitk::GenericProperty< T >, mitk::GenericProperty< Point4D >, mitk::GenericProperty< double >, mitk::GenericProperty< IntLookupTable >, mitk::GenericProperty< float >, mitk::GenericProperty< Point3I >, mitk::GenericProperty< int >, mitk::GenericProperty< FloatLookupTable >, mitk::GenericProperty< unsigned int >, mitk::GenericProperty< unsigned short >, mitk::GenericProperty< Vector3D >, mitk::GenericProperty< BoolLookupTable >, mitk::GenericProperty< Point2D >, mitk::GenericProperty< Point3D >, mitk::GenericProperty< bool >, mitk::GenericProperty< StringLookupTable >, mitk::PointSetShapeProperty, mitk::StringLookupTableProperty, mitk::EnumerationProperty, mitk::IntLookupTableProperty, mitk::BoolLookupTableProperty, mitk::StringProperty, mitk::FloatLookupTableProperty, mitk::Point3iProperty, mitk::TemporoSpatialStringProperty, mitk::PlaneOrientationProperty, mitk::TransferFunctionProperty, mitk::Point4dProperty, mitk::ClippingProperty, mitk::Point3dProperty, mitk::SmartPointerProperty, mitk::VtkScalarModeProperty, mitk::VtkVolumeRenderingProperty, mitk::GroupTagProperty, mitk::Point2dProperty, mitk::VtkResliceInterpolationProperty, mitk::ModalityProperty, mitk::Vector3DProperty, mitk::VtkInterpolationProperty, mitk::VtkRepresentationProperty, mitk::WeakPointerProperty, mitk::AnnotationProperty, mitk::DoubleProperty, mitk::ResliceMethodProperty, mitk::FloatProperty, mitk::UShortProperty, mitk::UIntProperty, mitk::IntProperty, and mitk::BoolProperty.

◆ GetStaticNameOfClass()

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

Definition at line 38 of file mitkBaseProperty.h.

◆ GetValueAsString()

std::string mitk::BaseProperty::GetValueAsString ( ) const
virtual

Reimplemented in mitk::TubeGraphProperty, mitk::EnumerationProperty, mitk::VectorProperty< DATATYPE >, mitk::TemporoSpatialStringProperty, mitk::ColorProperty, mitk::LevelWindowProperty, mitk::LookupTableProperty, mitk::ClippingProperty, mitk::GenericProperty< T >, mitk::IsoDoseLevelSetProperty, mitk::IsoDoseLevelVectorProperty, mitk::GenericProperty< Point4D >, mitk::GenericProperty< double >, mitk::GenericProperty< IntLookupTable >, mitk::GenericProperty< float >, mitk::GenericProperty< Point3I >, mitk::GenericProperty< int >, mitk::GenericProperty< FloatLookupTable >, mitk::GenericProperty< unsigned int >, mitk::GenericProperty< unsigned short >, mitk::GenericProperty< Vector3D >, mitk::GenericProperty< BoolLookupTable >, mitk::GenericProperty< Point2D >, mitk::GenericProperty< Point3D >, mitk::GenericProperty< bool >, mitk::GenericProperty< StringLookupTable >, mitk::StringProperty, mitk::AnnotationProperty, mitk::SmartPointerProperty, mitk::TransferFunctionProperty, mitk::WeakPointerProperty, and mitk::CameraIntrinsicsProperty.

Definition at line 29 of file mitkBaseProperty.cpp.

References VALUE_CANNOT_BE_CONVERTED_TO_STRING.

Referenced by QmitkPropertiesTableModel::data(), QmitkDataStorageTreeModel::data(), mitk::GetBackwardsCompatibleDICOMProperty(), mitk::GetCaseIDFromDataNode(), mitk::GetDICOMDateFromDataNode(), mitk::GetDICOMModalityFromDataNode(), mitk::GetIDFromDataNode(), mitk::DicomSeriesReader::LoadDicom(), QmitkBasePropertyView::PropertyChanged(), mitk::PropertyPersistenceSerialization::serializeByGetValueAsString(), and QmitkPatientInfoWidget::SetPatientInfo().

◆ operator=()

mitk::BaseProperty & mitk::BaseProperty::operator= ( const BaseProperty property)

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.

Definition at line 34 of file mitkBaseProperty.cpp.

References AssignProperty().

◆ operator==()

bool mitk::BaseProperty::operator== ( const BaseProperty property) const

Subclasses must implement IsEqual(const BaseProperty&) to support comparison.

operator== which is used by PropertyList to check whether a property has been changed.

Definition at line 53 of file mitkBaseProperty.cpp.

Member Data Documentation

◆ VALUE_CANNOT_BE_CONVERTED_TO_STRING

const std::string mitk::BaseProperty::VALUE_CANNOT_BE_CONVERTED_TO_STRING
static

Default return value if a property which can not be returned as string.

Definition at line 69 of file mitkBaseProperty.h.

Referenced by GetValueAsString(), mitk::LabelSetImageIO::Write(), and mitk::ItkImageIO::Write().


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