Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::NodePredicateDataProperty Class Reference

Predicate that evaluates if the data of a given DataNode has a specific property. More...

#include <mitkNodePredicateDataProperty.h>

Inheritance diagram for mitk::NodePredicateDataProperty:
Collaboration diagram for mitk::NodePredicateDataProperty:

Public Member Functions

 mitkClassMacro (NodePredicateDataProperty, NodePredicateBase)
 
 mitkNewMacro1Param (NodePredicateDataProperty, const char *)
 
 mitkNewMacro2Param (NodePredicateDataProperty, const char *, mitk::BaseProperty *)
 
 ~NodePredicateDataProperty () override
 Standard Destructor. More...
 
bool CheckNode (const mitk::DataNode *node) const override
 Checks if the node's data object has a property matching the stored criteria. More...
 
- Public Member Functions inherited from mitk::NodePredicateBase
 mitkClassMacroItkParent (NodePredicateBase, itk::Object)
 
 ~NodePredicateBase () override
 Virtual destructor. More...
 

Protected Member Functions

 NodePredicateDataProperty (const char *propertyName, mitk::BaseProperty *p=nullptr)
 Constructor to check for a named property. More...
 

Protected Attributes

mitk::BaseProperty::Pointer m_ValidProperty
 
std::string m_ValidPropertyName
 

Detailed Description

Predicate that evaluates if the data of a given DataNode has a specific property.

If the second parameter is nullptr, it will only be checked whether there is a property with the specified name for the data instance of the node.

Definition at line 28 of file mitkNodePredicateDataProperty.h.

Constructor & Destructor Documentation

◆ ~NodePredicateDataProperty()

mitk::NodePredicateDataProperty::~NodePredicateDataProperty ( )
override

Standard Destructor.

◆ NodePredicateDataProperty()

mitk::NodePredicateDataProperty::NodePredicateDataProperty ( const char *  propertyName,
mitk::BaseProperty *  p = nullptr 
)
protected

Constructor to check for a named property.

Parameters
propertyNameName of the property to look for (must not be empty).
pOptional property value to compare against. If nullptr, only the existence of the named property is checked.

Member Function Documentation

◆ CheckNode()

bool mitk::NodePredicateDataProperty::CheckNode ( const mitk::DataNode *  node) const
overridevirtual

Checks if the node's data object has a property matching the stored criteria.

If a valid property was supplied at construction, both name and value must match. If only a name was supplied, only the existence of the property is checked.

Parameters
nodeThe DataNode to check.
Returns
True if the data object has the matching property.

Implements mitk::NodePredicateBase.

◆ mitkClassMacro()

mitk::NodePredicateDataProperty::mitkClassMacro ( NodePredicateDataProperty  ,
NodePredicateBase   
)

◆ mitkNewMacro1Param()

mitk::NodePredicateDataProperty::mitkNewMacro1Param ( NodePredicateDataProperty  ,
const char *   
)

◆ mitkNewMacro2Param()

mitk::NodePredicateDataProperty::mitkNewMacro2Param ( NodePredicateDataProperty  ,
const char *  ,
mitk::BaseProperty *   
)

Member Data Documentation

◆ m_ValidProperty

mitk::BaseProperty::Pointer mitk::NodePredicateDataProperty::m_ValidProperty
protected

Definition at line 58 of file mitkNodePredicateDataProperty.h.

◆ m_ValidPropertyName

std::string mitk::NodePredicateDataProperty::m_ValidPropertyName
protected

Definition at line 60 of file mitkNodePredicateDataProperty.h.


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