vtkPVDataDeliveryManager.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPVDataDeliveryManager_h
#define vtkPVDataDeliveryManager_h
 
#include "vtkObject.h"
#include "vtkRemotingViewsModule.h" //needed for exports
#include "vtkSmartPointer.h"        // needed for iVar.
#include "vtkTuple.h"               // needed for vtkTuple.
#include "vtkWeakPointer.h"         // needed for iVar.
 
class vtkAlgorithmOutput;
class vtkDataObject;
class vtkExtentTranslator;
class vtkInformation;
class vtkPVDataRepresentation;
class vtkPVView;
 
#include <vector> // for std::vector
 
class VTKREMOTINGVIEWS_EXPORT vtkPVDataDeliveryManager : public vtkObject
{
public:
  vtkTypeMacro(vtkPVDataDeliveryManager, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  void SetView(vtkPVView*);
  vtkPVView* GetView() const;
 
  int GetSynchronizationMagicNumber();
 
 
  void RegisterRepresentation(vtkPVDataRepresentation* repr);
  void UnRegisterRepresentation(vtkPVDataRepresentation*);
  vtkPVDataRepresentation* GetRepresentation(unsigned int);
 
 
  void SetPiece(vtkPVDataRepresentation* repr, vtkDataObject* data, bool low_res,
    unsigned long trueSize = 0, int port = 0);
 
  bool HasPiece(vtkPVDataRepresentation* repr, bool low_res = false, int port = 0);
 
  vtkDataObject* GetPiece(vtkPVDataRepresentation* repr, bool low_res, int port = 0);
 
  vtkDataObject* GetDeliveredPiece(vtkPVDataRepresentation* repr, bool low_res, int port = 0);
 
  void ClearCache(vtkPVDataRepresentation* repr);
 
 
  vtkAlgorithmOutput* GetProducer(vtkPVDataRepresentation*, bool low_res, int port = 0);
 
 
  vtkInformation* GetPieceInformation(vtkPVDataRepresentation* repr, bool low_res, int port = 0);
 
 
  int GetNumberOfPorts(vtkPVDataRepresentation* repr);
 
  unsigned long GetVisibleDataSize(bool low_res);
 
  bool NeedsDelivery(
    vtkMTimeType timestamp, std::vector<unsigned int>& keys_to_deliver, bool use_lod);
 
  void Deliver(int use_low_res, unsigned int size, unsigned int* keys);
 
  virtual int GetDeliveredDataKey(bool low_res) const
  {
    (void)low_res;
    return 0;
  }
 
protected:
  vtkPVDataDeliveryManager();
  ~vtkPVDataDeliveryManager() override;
 
  double GetCacheKey(vtkPVDataRepresentation* repr) const;
 
  virtual void MoveData(vtkPVDataRepresentation* repr, bool low_res, int port) = 0;
 
  class vtkInternals;
  vtkInternals* Internals;
 
private:
  vtkPVDataDeliveryManager(const vtkPVDataDeliveryManager&) = delete;
  void operator=(const vtkPVDataDeliveryManager&) = delete;
 
  vtkWeakPointer<vtkPVView> View;
};
 
#endif