vtkCPProcessor.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkCPProcessor_h
#define vtkCPProcessor_h
 
#include "vtkObject.h"
#include "vtkPVCatalystModule.h" // For windows import/export of shared libraries
 
struct vtkCPProcessorInternals;
class vtkCPDataDescription;
class vtkCPPipeline;
class vtkMPICommunicatorOpaqueComm;
class vtkMultiProcessController;
class vtkSMSourceProxy;
 
 
class VTKPVCATALYST_EXPORT vtkCPProcessor : public vtkObject
{
public:
  static vtkCPProcessor* New();
  vtkTypeMacro(vtkCPProcessor, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  virtual int AddPipeline(vtkCPPipeline* pipeline);
 
  virtual int GetNumberOfPipelines();
 
  virtual vtkCPPipeline* GetPipeline(int which);
 
  virtual void RemovePipeline(vtkCPPipeline* pipeline);
  virtual void RemoveAllPipelines();
 
  // Controls cache size, in terms of timesteps, available for temporal
  // data caching. Default is zero, which disables any caching.
  virtual void SetTemporalCacheSize(int);
  vtkGetMacro(TemporalCacheSize, int);
 
  // Accessor to specific temporal cache. Names match CPInputData names
  virtual void MakeTemporalCache(const char* name);
  virtual vtkSMSourceProxy* GetTemporalCache(const char* name);
 
  virtual int Initialize(const char* workingDirectory = nullptr);
#ifndef __WRAP__
  virtual int Initialize(
    vtkMPICommunicatorOpaqueComm& comm, const char* workingDirectory = nullptr);
#endif
 
  // adaptor inputs to pipeline sources.
  static const char* GetInputArrayName() { return "__CatalystChannel__"; }
 
  virtual int RequestDataDescription(vtkCPDataDescription* dataDescription);
 
  virtual int CoProcess(vtkCPDataDescription* dataDescription);
 
  virtual int Finalize();
 
  vtkGetStringMacro(WorkingDirectory);
 
protected:
  vtkCPProcessor();
  ~vtkCPProcessor() override;
 
  virtual vtkObject* NewInitializationHelper();
 
  vtkSetStringMacro(WorkingDirectory);
 
  void FinalizeAndRemovePipelines();
 
private:
  vtkCPProcessor(const vtkCPProcessor&) = delete;
  void operator=(const vtkCPProcessor&) = delete;
 
  vtkCPProcessorInternals* Internal;
  vtkObject* InitializationHelper;
  static vtkMultiProcessController* Controller;
  char* WorkingDirectory;
  int TemporalCacheSize = 0;
};
 
#endif