vtkSMSourceProxy.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMSourceProxy_h
#define vtkSMSourceProxy_h
 
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMProxy.h"
 
class vtkPVArrayInformation;
class vtkPVDataInformation;
class vtkPVDataSetAttributesInformation;
 
struct vtkSMSourceProxyInternals;
 
class vtkSMOutputPort;
class vtkSMProperty;
class vtkSMSessionProxyManager;
 
class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMSourceProxy : public vtkSMProxy
{
public:
  static vtkSMSourceProxy* New();
  vtkTypeMacro(vtkSMSourceProxy, vtkSMProxy);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void UpdatePipelineInformation() override;
 
  virtual void UpdatePipeline();
 
  virtual void UpdatePipeline(double time);
 
 
  vtkGetMacro(OutputPortsCreated, int);
 
  virtual unsigned int GetNumberOfOutputPorts();
 
  virtual vtkSMOutputPort* GetOutputPort(unsigned int idx);
 
  virtual vtkSMOutputPort* GetOutputPort(const char* portname);
 
  virtual unsigned int GetOutputPortIndex(const char* portname);
 
  virtual const char* GetOutputPortName(unsigned int index);
 
 
  vtkSMDocumentation* GetOutputPortDocumentation(unsigned int index);
  vtkSMDocumentation* GetOutputPortDocumentation(const char* portname);
 
  virtual void CreateOutputPorts();
 
 
  vtkPVDataInformation* GetDataInformation() { return this->GetDataInformation(0); }
  vtkPVDataInformation* GetDataInformation(unsigned int outputIdx);
 
 
  vtkPVDataInformation* GetSubsetDataInformation(
    unsigned int outputIdx, const char* selector, const char* assemblyName = nullptr);
 
  vtkPVDataInformation* GetSubsetDataInformation(
    unsigned int outputIdx, unsigned int compositeIndex);
 
 
  vtkPVDataInformation* GetRankDataInformation(int rank)
  {
    return this->GetRankDataInformation(0u, rank);
  }
  vtkPVDataInformation* GetRankDataInformation(unsigned int outputIdx, int rank);
 
  virtual void CreateSelectionProxies();
 
  void SetSelectionInput(unsigned int portIndex, vtkSMSourceProxy* input, unsigned int outputPort);
 
 
  vtkSMSourceProxy* GetSelectionInput(unsigned int portIndex);
  unsigned int GetSelectionInputPort(unsigned int portIndex);
 
  void CleanSelectionInputs(unsigned int portIndex);
 
  vtkSMSourceProxy* GetSelectionOutput(unsigned int portIndex);
 
 
  vtkGetMacro(ProcessSupport, int);
 
 
  vtkGetMacro(MPIRequired, bool);
 
  unsigned int GetNumberOfAlgorithmOutputPorts();
 
  virtual unsigned int GetNumberOfAlgorithmRequiredInputPorts();
 
  vtkTypeUInt32 GetGlobalID() override;
 
  enum ProcessSupportType
  {
    SINGLE_PROCESS,
    MULTIPLE_PROCESSES,
    BOTH
  };
 
  void MarkDirty(vtkSMProxy* modifiedProxy) override;
 
protected:
  vtkSMSourceProxy();
  ~vtkSMSourceProxy() override;
 
  friend class vtkSMInputProperty;
  friend class vtkSMOutputPort;
 
  int OutputPortsCreated;
 
  int ProcessSupport;
  bool MPIRequired;
 
  virtual void InvalidateDataInformation();
 
  void CreateVTKObjects() override;
 
  char* ExecutiveName;
  vtkSetStringMacro(ExecutiveName);
 
  int ReadXMLAttributes(vtkSMSessionProxyManager* pm, vtkPVXMLElement* element) override;
 
 
  void SetOutputPort(
    unsigned int index, const char* name, vtkSMOutputPort* port, vtkSMDocumentation* doc);
  void RemoveAllOutputPorts();
  void SetExtractSelectionProxy(unsigned int index, vtkSMSourceProxy* proxy);
  void RemoveAllExtractSelectionProxies();
 
  void PostUpdateData(bool) override;
 
  void SetLogNameInternal(
    const char* name, bool propagate_to_subproxies, bool propagate_to_proxylistdomains) override;
 
  // flag used to avoid creation of extract selection proxies for this source
  // proxy.
  bool DisableSelectionProxies;
  bool SelectionProxiesCreated;
 
private:
  vtkSMSourceProxyInternals* PInternals;
 
  // used by GetNumberOfAlgorithmOutputPorts to cache the value to avoid
  // unnecessary information gathers.
  unsigned int NumberOfAlgorithmOutputPorts;
  unsigned int NumberOfAlgorithmRequiredInputPorts;
 
  vtkSMSourceProxy(const vtkSMSourceProxy&) = delete;
  void operator=(const vtkSMSourceProxy&) = delete;
};
 
#endif