mitkBaseDataSource.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

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

#ifndef MITK_BASE_DATA_SOURCE_H
#define MITK_BASE_DATA_SOURCE_H

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

#define mitkBaseDataSourceGetOutputDeclarations                                                                        \
  OutputType *GetOutput();                                                                                             \
  const OutputType *GetOutput() const;                                                                                 \
  OutputType *GetOutput(DataObjectPointerArraySizeType idx);                                                           \
  const OutputType *GetOutput(DataObjectPointerArraySizeType idx) const;

#define mitkBaseDataSourceGetOutputDefinitions(className)                                                              \
  className::OutputType *className::GetOutput(void)                                                                    \
  {                                                                                                                    \
    return itkDynamicCastInDebugMode<OutputType *>(this->GetPrimaryOutput());                                          \
  }                                                                                                                    \
  const className::OutputType *className::GetOutput(void) const                                                        \
  {                                                                                                                    \
    return itkDynamicCastInDebugMode<const OutputType *>(this->GetPrimaryOutput());                                    \
  }                                                                                                                    \
  className::OutputType *className::GetOutput(DataObjectPointerArraySizeType idx)                                      \
  {                                                                                                                    \
    OutputType *out = dynamic_cast<OutputType *>(this->ProcessObject::GetOutput(idx));                                 \
    if (out == nullptr && this->ProcessObject::GetOutput(idx) != nullptr)                                                    \
    {                                                                                                                  \
      itkWarningMacro(<< "Unable to convert output number " << idx << " to type " << typeid(OutputType).name());       \
    }                                                                                                                  \
    return out;                                                                                                        \
  }                                                                                                                    \
  const className::OutputType *className::GetOutput(DataObjectPointerArraySizeType idx) const                          \
  {                                                                                                                    \
    const OutputType *out = dynamic_cast<const OutputType *>(this->ProcessObject::GetOutput(idx));                     \
    if (out == nullptr && this->ProcessObject::GetOutput(idx) != nullptr)                                                    \
    {                                                                                                                  \
      itkWarningMacro(<< "Unable to convert output number " << idx << " to type " << typeid(OutputType).name());       \
    }                                                                                                                  \
    return out;                                                                                                        \
  }

namespace mitk
{
  class BaseData;

  class MITKCORE_EXPORT BaseDataSource : public itk::ProcessObject
  {
  public:
    mitkClassMacroItkParent(BaseDataSource, itk::ProcessObject);

      typedef BaseData OutputType;
    typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType;

    mitkBaseDataSourceGetOutputDeclarations

      virtual void
      GraftOutput(OutputType *output);

    virtual void GraftOutput(const DataObjectIdentifierType &key, OutputType *output);

    virtual void GraftNthOutput(unsigned int idx, OutputType *output);

    DataObjectPointer MakeOutput(DataObjectPointerArraySizeType idx) override = 0;

    DataObjectPointer MakeOutput(const DataObjectIdentifierType &name) override = 0;

    bool Updating() const;

  protected:
    BaseDataSource();
    ~BaseDataSource() override;

    // purposely not implemented
    static Pointer New();
  };

} // namespace mitk

#endif /* MITK_BASE_DATA_SOURCE_H */