vtkPVDataMover.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPVDataMover_h
#define vtkPVDataMover_h
 
#include "vtkObject.h"
#include "vtkRemotingServerManagerModule.h" // for exports
 
#include <map>    // for std::map
#include <vector> // for std::vector
 
class vtkAlgorithm;
class vtkDataObject;
 
class VTKREMOTINGSERVERMANAGER_EXPORT vtkPVDataMover : public vtkObject
{
public:
  static vtkPVDataMover* New();
  vtkTypeMacro(vtkPVDataMover, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  void SetProducer(vtkAlgorithm* producer);
  vtkGetObjectMacro(Producer, vtkAlgorithm);
 
 
  vtkSetClampMacro(PortNumber, int, 0, VTK_INT_MAX);
  vtkGetMacro(PortNumber, int);
 
 
  vtkSetMacro(GatherOnAllRanks, bool);
  vtkGetMacro(GatherOnAllRanks, bool);
 
 
  vtkSetMacro(SkipEmptyDataSets, bool);
  vtkGetMacro(SkipEmptyDataSets, bool);
  vtkBooleanMacro(SkipEmptyDataSets, bool);
 
 
 
  void AddSourceRank(int rank);
  void ClearAllSourceRanks();
  void SetSourceRanks(const std::vector<int>& ranks);
  const std::vector<int>& GetSourceRanks() const { return this->SourceRanks; }
 
  bool Execute();
 
 
  unsigned int GetNumberOfDataSets() const;
  int GetDataSetRank(unsigned int index) const;
  vtkDataObject* GetDataSetAtIndex(unsigned int index) const;
  vtkDataObject* GetDataSetFromRank(int rank) const;
protected:
  vtkPVDataMover();
  ~vtkPVDataMover() override;
 
private:
  vtkPVDataMover(const vtkPVDataMover&) = delete;
  void operator=(const vtkPVDataMover&) = delete;
 
  vtkAlgorithm* Producer = nullptr;
  int PortNumber = 0;
  bool GatherOnAllRanks = false;
  bool SkipEmptyDataSets = false;
 
  std::vector<int> SourceRanks;
  std::map<int, vtkSmartPointer<vtkDataObject>> DataSets;
};
 
#endif