Medical Imaging Interaction Toolkit  2023.12.99-63768887
Medical Imaging Interaction Toolkit
mitk::RegVisStyleProperty Class Reference

#include <mitkRegVisStyleProperty.h>

Inheritance diagram for mitk::RegVisStyleProperty:
Collaboration diagram for mitk::RegVisStyleProperty:

Public Member Functions

 mitkClassMacro (RegVisStyleProperty, EnumerationProperty)
 
 mitkNewMacro1Param (RegVisStyleProperty, const IdType &)
 
 mitkNewMacro1Param (RegVisStyleProperty, const std::string &)
 
BasePropertyoperator= (const BaseProperty &property)
 Assigns property to this BaseProperty instance. More...
 
- Public Member Functions inherited from mitk::EnumerationProperty
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
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 EnumIdsContainerTypeGetEnumIds () const
 
const EnumStringsContainerTypeGetEnumStrings () const
 
EnumIdsContainerTypeGetEnumIds ()
 
EnumStringsContainerTypeGetEnumStrings ()
 
bool ToJSON (nlohmann::json &j) const override
 
bool FromJSON (const nlohmann::json &j) override
 
EnumerationPropertyoperator= (const EnumerationProperty &)=delete
 
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 Pointer New ()
 
- 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

 RegVisStyleProperty ()
 
 RegVisStyleProperty (const IdType &value)
 
 RegVisStyleProperty (const std::string &value)
 
bool AddEnum (const std::string &name, const IdType &id) override
 
void AddTypes ()
 
- Protected Member Functions inherited from mitk::EnumerationProperty
 EnumerationProperty ()
 
 EnumerationProperty (const EnumerationProperty &)
 
bool IsEqual (const BaseProperty &property) const override
 
bool Assign (const BaseProperty &property) override
 
virtual itk::LightObject::Pointer InternalClone () const override
 
- Protected Member Functions inherited from mitk::BaseProperty
 BaseProperty ()
 
 BaseProperty (const BaseProperty &other)
 
 ~BaseProperty () override
 

Additional Inherited Members

- Public Types inherited from mitk::EnumerationProperty
typedef EnumerationProperty Self
 
typedef BaseProperty Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef unsigned int IdType
 
typedef std::map< IdType, std::string > EnumIdsContainerType
 
typedef std::map< std::string, IdTypeEnumStringsContainerType
 
typedef EnumIdsContainerType::const_iterator EnumConstIterator
 
- Public Types inherited from mitk::BaseProperty
typedef BaseProperty Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- 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

Encapsulates the enumeration for visualization styles. Valid values are: 0/Grid, 1/Glyph, 2/Points Default is "Grid"

Definition at line 36 of file mitkRegVisStyleProperty.h.

Constructor & Destructor Documentation

◆ RegVisStyleProperty() [1/3]

mitk::RegVisStyleProperty::RegVisStyleProperty ( )
protected

Constructor. Sets the representation to a default value of 0

◆ RegVisStyleProperty() [2/3]

mitk::RegVisStyleProperty::RegVisStyleProperty ( const IdType value)
protected

Constructor. Sets the enumeration to the given value. If it is not valid, the enumeration is set to 0

◆ RegVisStyleProperty() [3/3]

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

Constructor. Sets the enumeration to the given value. If it is not valid, the enumeration is set to 0

Member Function Documentation

◆ AddEnum()

bool mitk::RegVisStyleProperty::AddEnum ( const std::string &  name,
const IdType id 
)
overrideprotectedvirtual

this function is overridden as protected, so that the user may not add additional invalid interpolation types.

Reimplemented from mitk::EnumerationProperty.

◆ AddTypes()

void mitk::RegVisStyleProperty::AddTypes ( )
protected

Adds the enumeration types

◆ mitkClassMacro()

mitk::RegVisStyleProperty::mitkClassMacro ( RegVisStyleProperty  ,
EnumerationProperty   
)

◆ mitkNewMacro1Param() [1/2]

mitk::RegVisStyleProperty::mitkNewMacro1Param ( RegVisStyleProperty  ,
const IdType  
)

◆ mitkNewMacro1Param() [2/2]

mitk::RegVisStyleProperty::mitkNewMacro1Param ( RegVisStyleProperty  ,
const std::string &   
)

◆ New()

static Pointer mitk::RegVisStyleProperty::New ( )
static

◆ 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: