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

Superclass of all classes generating data tree nodes (instances of class mitk::DataNode) as output. More...

#include <mitkDataNodeSource.h>

Inheritance diagram for mitk::DataNodeSource:
Collaboration diagram for mitk::DataNodeSource:

Public Types

typedef DataNodeSource Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef mitk::DataNode OutputType
 
typedef OutputType::Pointer OutputTypePointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
DataObjectPointer MakeOutput (const DataObjectIdentifierType &name) override
 
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 

Protected Member Functions

 DataNodeSource ()
 
 ~DataNodeSource () override
 

Detailed Description

Superclass of all classes generating data tree nodes (instances of class mitk::DataNode) as output.

In itk and vtk the generated result of a ProcessObject is only guaranteed to be up-to-date, when Update() of the ProcessObject or the generated DataObject is called immediately before access of the data stored in the DataObject. This is also true for subclasses of mitk::BaseProcess and thus for mitk::DataNodeSource.

Definition at line 32 of file mitkDataNodeSource.h.

Member Typedef Documentation

◆ ConstPointer

◆ OutputType

◆ OutputTypePointer

◆ Pointer

◆ Self

◆ Superclass

typedef itk::ProcessObject mitk::DataNodeSource::Superclass

Definition at line 35 of file mitkDataNodeSource.h.

Constructor & Destructor Documentation

◆ DataNodeSource()

mitk::DataNodeSource::DataNodeSource ( )
protected

◆ ~DataNodeSource()

mitk::DataNodeSource::~DataNodeSource ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::DataNodeSource::Clone ( ) const

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::DataNodeSource::GetClassHierarchy ( ) const
inlinevirtual

Definition at line 35 of file mitkDataNodeSource.h.

◆ GetClassName()

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

◆ GetOutput() [1/4]

OutputType* mitk::DataNodeSource::GetOutput ( )

◆ GetOutput() [2/4]

const OutputType* mitk::DataNodeSource::GetOutput ( ) const

◆ GetOutput() [3/4]

OutputType* mitk::DataNodeSource::GetOutput ( DataObjectPointerArraySizeType  idx)

◆ GetOutput() [4/4]

const OutputType* mitk::DataNodeSource::GetOutput ( DataObjectPointerArraySizeType  idx) const

◆ GetStaticNameOfClass()

static const char* mitk::DataNodeSource::GetStaticNameOfClass ( )
inlinestatic

Definition at line 35 of file mitkDataNodeSource.h.

◆ MakeOutput() [1/2]

DataObjectPointer mitk::DataNodeSource::MakeOutput ( const DataObjectIdentifierType &  name)
override

This is a default implementation to make sure we have something. Once all the subclasses of ProcessObject provide an appropriate MakeOutput(), then ProcessObject::MakeOutput() can be made pure virtual.

◆ MakeOutput() [2/2]

DataObjectPointer mitk::DataNodeSource::MakeOutput ( DataObjectPointerArraySizeType  idx)
override

Allocates a new output object and returns it. Currently the index idx is not evaluated.

Parameters
idxthe index of the output for which an object should be created
Returns
the new object

◆ New()

static Pointer mitk::DataNodeSource::New ( )
static

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