vtkForEach.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkForEach_h
#define vtkForEach_h

#include "vtkCommonExecutionModelModule.h" // for export macro
#include "vtkDataObjectAlgorithm.h"

#include <memory> // for std::unique_ptr

VTK_ABI_NAMESPACE_BEGIN

class vtkEndFor;
class vtkExecutionRange;
class vtkInformationObjectBaseKey;
class VTKCOMMONEXECUTIONMODEL_EXPORT vtkForEach : public vtkDataObjectAlgorithm
{
public:
  static vtkForEach* New();
  vtkTypeMacro(vtkForEach, vtkDataObjectAlgorithm);
  void PrintSelf(std::ostream& os, vtkIndent indent) override;

  static vtkInformationObjectBaseKey* FOR_EACH_FILTER();

  virtual void SetRange(vtkExecutionRange*);

  virtual bool IsIterating();

  void Iter();

  virtual void RegisterEndFor(vtkEndFor*);

protected:
  vtkForEach();
  ~vtkForEach() override;

  int RequestDataObject(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

private:
  vtkForEach(const vtkForEach&) = delete;
  void operator=(const vtkForEach&) = delete;

  struct Internals;
  std::unique_ptr<Internals> Internal;
};

VTK_ABI_NAMESPACE_END

#endif // vtkForEach_h