Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
mitk::DataNodeSource Class Reference
MITK Modules » Core » Process and Adaptor Classes » Process Classes

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

#include <mitkDataNodeSource.h>

Inheritance diagram for mitk::DataNodeSource:
Inheritance graph
[legend]
Collaboration diagram for mitk::DataNodeSource:
Collaboration graph
[legend]

Public Types

typedef DataNodeSource Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
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
 
OutputType * GetOutput ()
 
const OutputType * GetOutput () const
 
OutputType * GetOutput (DataObjectPointerArraySizeType idx)
 
const OutputType * GetOutput (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

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

Definition at line 35 of file mitkDataNodeSource.h.

◆ OutputType

typedef mitk::DataNode mitk::DataNodeSource::OutputType

Definition at line 39 of file mitkDataNodeSource.h.

◆ OutputTypePointer

typedef OutputType::Pointer mitk::DataNodeSource::OutputTypePointer

Definition at line 43 of file mitkDataNodeSource.h.

◆ Pointer

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

Definition at line 35 of file mitkDataNodeSource.h.

◆ Self

typedef DataNodeSource mitk::DataNodeSource::Self

Definition at line 35 of file mitkDataNodeSource.h.

◆ Superclass

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

Definition at line 35 of file mitkDataNodeSource.h.

Constructor & Destructor Documentation

◆ DataNodeSource()

mitk::DataNodeSource::DataNodeSource ( )
protected

Definition at line 15 of file mitkDataNodeSource.cpp.

References MakeOutput().

◆ ~DataNodeSource()

mitk::DataNodeSource::~DataNodeSource ( )
overrideprotected

Definition at line 22 of file mitkDataNodeSource.cpp.

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]

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

Definition at line 41 of file mitkDataNodeSource.cpp.

◆ GetOutput() [2/4]

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

Definition at line 46 of file mitkDataNodeSource.cpp.

◆ GetOutput() [3/4]

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

Definition at line 51 of file mitkDataNodeSource.cpp.

◆ GetOutput() [4/4]

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

Definition at line 56 of file mitkDataNodeSource.cpp.

◆ GetStaticNameOfClass()

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

Definition at line 35 of file mitkDataNodeSource.h.

◆ MakeOutput() [1/2]

itk::ProcessObject::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

Definition at line 26 of file mitkDataNodeSource.cpp.

References mitk::DataNode::New().

Referenced by DataNodeSource(), and MakeOutput().

◆ MakeOutput() [2/2]

itk::ProcessObject::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 appopriate MakeOutput(), then ProcessObject::MakeOutput() can be made pure virtual.

Definition at line 31 of file mitkDataNodeSource.cpp.

References MakeOutput(), and mitk::DataNode::New().

◆ New()

static Pointer mitk::DataNodeSource::New ( )
static
The documentation for this class was generated from the following files: