Property class that carries no value, used as a tag for group membership. More...
#include <mitkGroupTagProperty.h>
Public Member Functions | |
| mitkClassMacro (GroupTagProperty, BaseProperty) | |
| Pointer | Clone () const |
| bool | ToJSON (nlohmann::json &j) const override |
| Serialize the group tag to JSON. More... | |
| bool | FromJSON (const nlohmann::json &j) override |
| Deserialize the group tag from JSON. More... | |
| BaseProperty & | operator= (const BaseProperty &property) |
| Assign a property value to this instance. More... | |
 Public Member Functions inherited from mitk::BaseProperty | |
| mitkClassMacroItkParent (BaseProperty, itk::Object) | |
| Pointer | Clone () const |
| bool | operator== (const BaseProperty &property) const |
| Compare two properties for equality. More... | |
| BaseProperty & | operator= (const BaseProperty &property) |
| Assign a property value to this instance. More... | |
| bool | AssignProperty (const BaseProperty &property) |
| Assign a property value to this instance and report success. More... | |
| virtual std::string | GetValueAsString () const |
| Return the property value as a human-readable string. More... | |
Static Public Member Functions | |
| static Pointer | New () |
Protected Member Functions | |
| GroupTagProperty () | |
| GroupTagProperty (const GroupTagProperty &) | |
| mitkCloneMacro (GroupTagProperty) | |
| 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 for properties that cannot be converted to a string. More... | |
Detailed Description
Property class that carries no value, used as a tag for group membership.
The GroupTag property is used to tag a data tree node to indicate that it is a member of a group of data tree nodes. This enables building groups of nodes without requiring a specific hierarchical order in the data tree. Its mere presence on a node signals group membership.
- See also
- BaseProperty
Definition at line 30 of file mitkGroupTagProperty.h.
Constructor & Destructor Documentation
◆ GroupTagProperty() [1/2]
|
protected |
◆ GroupTagProperty() [2/2]
|
protected |
Member Function Documentation
◆ Clone()
| Pointer mitk::GroupTagProperty::Clone | ( | ) | const |
◆ FromJSON()
|
overridevirtual |
Deserialize the group tag from JSON.
Since GroupTagProperty has no value, this is essentially a no-op.
- Parameters
-
[in] j The JSON value to read from.
- Returns
- Always
true.
Implements mitk::BaseProperty.
◆ mitkClassMacro()
| mitk::GroupTagProperty::mitkClassMacro | ( | GroupTagProperty | , |
| BaseProperty | |||
| ) |
◆ mitkCloneMacro()
|
protected |
◆ New()
|
static |
◆ operator=()
| BaseProperty& mitk::BaseProperty::operator= |
Assign a property value to this instance.
Performs a polymorphic assignment from the given property. The assignment succeeds only if the source and target properties are of the same type. The subclass-specific Assign() method is called to perform the actual value copy.
Subclasses must implement Assign(const BaseProperty&) and call the superclass Assign method for proper handling. The copy assignment operator of the subclass should be disabled and the base class operator should be made visible using "using" statements.
- Parameters
-
[in] property The property whose value should be assigned to this instance.
- Returns
- A reference to this property.
- See also
- AssignProperty
- Assign
◆ ToJSON()
|
overridevirtual |
Serialize the group tag to JSON.
Since GroupTagProperty has no value, this writes a null JSON value.
- Parameters
-
[out] j The JSON value to write into.
- Returns
- Always
true.
Implements mitk::BaseProperty.
The documentation for this class was generated from the following file:
