mitk::BoolProperty Class Reference

#include <mitkProperties.h>

Inheritance diagram for mitk::BoolProperty:

Collaboration diagram for mitk::BoolProperty:

Public Types
typedef BoolProperty	Self
typedef GenericProperty< bool >	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
Public Types inherited from mitk::GenericProperty< bool >
typedef GenericProperty	Self
typedef BaseProperty	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
typedef bool	ValueType
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
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...
BaseProperty &	operator= (const BaseProperty &property)
	Assigns property to this BaseProperty instance. More...
Public Member Functions inherited from mitk::GenericProperty< bool >
virtual std::vector< std::string >	GetClassHierarchy () const override
virtual const char *	GetClassName () const
Pointer	Clone () const
virtual void	SetValue (bool _arg)
virtual bool	GetValue () const
std::string	GetValueAsString () const override
bool	ToJSON (nlohmann::json &) const override
	Serialize property value(s) to JSON. More...
bool	FromJSON (const nlohmann::json &) override
	Deserialize property value(s) from JSON. More...
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...
virtual std::string	GetValueAsString () const

Static Public Member Functions
static const char *	GetStaticNameOfClass ()
static Pointer	New ()
static Pointer	New (bool _arg)
Static Public Member Functions inherited from mitk::GenericProperty< bool >
static const char *	GetStaticNameOfClass ()
static Pointer	New (bool _arg)
Static Public Member Functions inherited from mitk::BaseProperty
static const char *	GetStaticNameOfClass ()

Protected Member Functions
	BoolProperty ()
	BoolProperty (const BoolProperty &)
	BoolProperty (bool x)
Protected Member Functions inherited from mitk::GenericProperty< bool >
	GenericProperty ()
	GenericProperty (bool x)
	GenericProperty (const GenericProperty &other)
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...
Protected Attributes inherited from mitk::GenericProperty< bool >
bool	m_Value

Detailed Description

Definition at line 22 of file mitkProperties.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 22 of file mitkProperties.h.

Pointer

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

Definition at line 22 of file mitkProperties.h.

Self

typedef BoolProperty mitk::BoolProperty::Self

Definition at line 22 of file mitkProperties.h.

Superclass

typedef GenericProperty< bool > mitk::BoolProperty::Superclass

Definition at line 22 of file mitkProperties.h.

Constructor & Destructor Documentation

BoolProperty() [1/3]

mitk::BoolProperty::BoolProperty ( )

protected

BoolProperty() [2/3]

mitk::BoolProperty::BoolProperty ( const BoolProperty &  )

protected

BoolProperty() [3/3]

mitk::BoolProperty::BoolProperty ( bool  x )

protected

Member Function Documentation

Clone()

Pointer mitk::BoolProperty::Clone

(

)

const

FromJSON()

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

inlineoverridevirtual

Reimplemented from mitk::BaseProperty.

Definition at line 22 of file mitkProperties.h.

GetClassName()

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

virtual

Reimplemented from mitk::BaseProperty.

GetStaticNameOfClass()

static const char* mitk::BoolProperty::GetStaticNameOfClass ( )

inlinestatic

Definition at line 22 of file mitkProperties.h.

New() [1/2]

static Pointer mitk::BoolProperty::New ( )

static

New() [2/2]

static Pointer mitk::BoolProperty::New ( bool  _arg )

inlinestatic

Definition at line 22 of file mitkProperties.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.

ToJSON()

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

---

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

• mitkProperties.h