mitkBaseProcess.h

Go to the documentation of this file.

/*=========================================================================

Program:   Medical Imaging & Interaction Toolkit
Language:  C++
Date:      $Date$
Version:   $Revision$

Copyright (c) German Cancer Research Center, Division of Medical and
Biological Informatics. All rights reserved.
See MITKCopyright.txt or https://www.mitk.org/copyright.html for details.

This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.  See the above copyright notices for more information.

=========================================================================*/


#ifndef BASEPROCESS_H_HEADER_INCLUDED_C19BE6FC
#define BASEPROCESS_H_HEADER_INCLUDED_C19BE6FC

#if(_MSC_VER==1200)
#include <itkFixedArray.h>
#endif

#include "mitkCommon.h"
#include <itkProcessObject.h>

namespace mitk {

class BaseData;

//##Documentation
//## @brief Superclass of all classes generating some kind of mitk::BaseData.
//##
//## Superclass of all classes generating some kind of mitk::BaseData.
//## 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. But
//## many of the subclasses of mitk::BaseProcess define additional access
//## functions to the generated output that guarantee an up-to-date result, see
//## for example mitk::ImageSource. 
//## @ingroup Process
class MITK_CORE_EXPORT BaseProcess : public itk::ProcessObject
{
public:
  mitkClassMacro(BaseProcess, itk::ProcessObject);

  //##Documentation
  //## @brief Access itk::ProcessObject::m_Updating
  //##
  //## m_Updating indicates when the pipeline is executing.
  //## It prevents infinite recursion when pipelines have loops.
  //## \sa itk::ProcessObject::m_Updating
  bool Updating() const
  {
    return m_Updating;
  }

  //##Documentation
  //## @brief Helps to deal with the weak-pointer-problem.
  virtual void UnRegister() const;

  //##Documentation
  //## @brief Helps to deal with the weak-pointer-problem.
  virtual int GetExternalReferenceCount() const;

protected:

  BaseProcess();

  virtual ~BaseProcess();

  //##Documentation
  //## @brief Protected methods for setting outputs.
  //## 
  //## Subclasses make use of them for getting output. 
  //## These are only overwritten because of itk::DataObject::ConnectSource being 
  //## private and non-virtual: the important stuff is done in 
  //## mitk::BaseData::ConnectSource.
  virtual void SetNthOutput(unsigned int num, itk::DataObject *output);

  //##Documentation
  //## @brief Protected methods for setting outputs.
  //## 
  //## Subclasses make use of them for getting output. 
  //## These are only overwritten because of itk::DataObject::ConnectSource being 
  //## private and non-virtual: the important stuff is done in 
  //## mitk::BaseData::ConnectSource.
  virtual void AddOutput(itk::DataObject *output);

private:

  //##Documentation
  //## @brief Helps to deal with the weak-pointer-problem.
  mutable bool m_Unregistering;

  //##Documentation
  //## @brief Helps to deal with the weak-pointer-problem.
  mutable bool m_CalculatingExternalReferenceCount;

  //##Documentation
  //## @brief Helps to deal with the weak-pointer-problem.
  mutable int m_ExternalReferenceCount;
};

} // namespace mitk

#endif /* BASEPROCESS_H_HEADER_INCLUDED_C19BE6FC */