Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
mitkNodePredicateData.h
Go to the documentation of this file.
1 /*============================================================================
2 
3 The Medical Imaging Interaction Toolkit (MITK)
4 
5 Copyright (c) German Cancer Research Center (DKFZ)
6 All rights reserved.
7 
8 Use of this source code is governed by a 3-clause BSD license that can be
9 found in the LICENSE file.
10 
11 ============================================================================*/
12 
13 #ifndef mitkNodePredicateData_h
14 #define mitkNodePredicateData_h
15 
16 #include "mitkNodePredicateBase.h"
17 
18 namespace mitk
19 {
20  class BaseData;
21 
22  //##Documentation
23  //## @brief Predicate that evaluates if the given DataNodes data object pointer equals a given pointer
24  //##
25  //## NodePredicateData(nullptr) returns true if a DataNode does not have a data object (e.g. ->GetData() returns nullptr).
26  //## This could return an unexpected number of nodes (e.g. the root node of the tree)
27  //## @warning NodePredicateData holds a weak pointer to a BaseData! NodePredicateData p(mitk::BaseData::New()); will
28  //not
29  // work.
30  //## Intended use is: NodePredicateData p(myDataObject); result = myDataStorage->GetSubset(p); Then work with
31  // result, do not reuse p later.
32  //##
33  //## @ingroup DataStorage
35  {
36  public:
39 
40  //##Documentation
41  //## @brief Standard Destructor
42  ~NodePredicateData() override;
43 
44  //##Documentation
45  //## @brief Checks, if the nodes data object is of a specific data type
46  bool CheckNode(const mitk::DataNode *node) const override;
47 
48  protected:
49  //##Documentation
50  //## @brief Protected constructor, use static instantiation functions instead
52 
54  };
55 } // namespace mitk
56 
57 #endif
mitk::NodePredicateData::m_DataObject
mitk::BaseData * m_DataObject
Definition: mitkNodePredicateData.h:53
mitkNewMacro1Param
#define mitkNewMacro1Param(classname, type)
Definition: mitkCommon.h:68
mitk::NodePredicateBase
Interface for evaluation conditions used in the DataStorage class GetSubset() method.
Definition: mitkNodePredicateBase.h:35
mitkNodePredicateBase.h
mitk
Find image slices visible on a given plane.
Definition: RenderingTests.dox:1
mitk::NodePredicateData
Predicate that evaluates if the given DataNodes data object pointer equals a given pointer.
Definition: mitkNodePredicateData.h:34
mitk::BaseData
Base of all data objects.
Definition: mitkBaseData.h:42
mitkClassMacro
#define mitkClassMacro(className, SuperClassName)
Definition: mitkCommon.h:36
MITKCORE_EXPORT
#define MITKCORE_EXPORT
Definition: MitkCoreExports.h:15
mitk::DataNode
Class for nodes of the DataTree.
Definition: mitkDataNode.h:63