vtkSMOutputPort.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMOutputPort_h
#define vtkSMOutputPort_h
 
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMProxy.h"
#include "vtkSmartPointer.h" // needed for vtkSmartPointer
#include "vtkWeakPointer.h"  // needed for vtkWeakPointer
 
#include <map> // needed for std::map
 
class vtkCollection;
class vtkPVClassNameInformation;
class vtkPVDataAssemblyInformation;
class vtkPVDataInformation;
class vtkPVTemporalDataInformation;
class vtkSMCompoundSourceProxy;
class vtkSMSourceProxy;
 
class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMOutputPort : public vtkSMProxy
{
public:
  static vtkSMOutputPort* New();
  vtkTypeMacro(vtkSMOutputPort, vtkSMProxy);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  virtual vtkPVDataInformation* GetDataInformation();
 
  vtkPVDataInformation* GetRankDataInformation(int rank);
 
 
  vtkPVDataInformation* GetSubsetDataInformation(
    const char* selector, const char* assemblyName = nullptr);
 
  vtkPVDataInformation* GetSubsetDataInformation(unsigned int compositeIndex);
 
  virtual vtkPVTemporalDataInformation* GetTemporalDataInformation();
 
  virtual const char* GetDataClassName();
 
  virtual vtkPVClassNameInformation* GetClassNameInformation();
 
  virtual void InvalidateDataInformation();
 
 
  vtkGetMacro(PortIndex, int);
 
  vtkSMSourceProxy* GetSourceProxy();
 
 
  vtkSMSession* GetSession() override;
  vtkSMSessionProxyManager* GetSessionProxyManager() override;
protected:
  vtkSMOutputPort();
  ~vtkSMOutputPort() override;
 
  virtual void GatherClassNameInformation();
 
  virtual void GatherDataInformation();
 
  virtual void GatherTemporalDataInformation();
 
  void SetSourceProxy(vtkSMSourceProxy* src);
 
  // When set to non-nullptr, GetSourceProxy() returns this rather than the real
  // source-proxy set using SetSourceProxy(). This provides a mechanism for
  // vtkSMCompoundSourceProxy to take ownership of ports that don't really
  // belong to it.
  void SetCompoundSourceProxy(vtkSMCompoundSourceProxy* src);
 
  virtual void UpdatePipelineInternal(double time, bool doTime);
 
  // The index of the port the output is obtained from.
  vtkSetMacro(PortIndex, int);
  int PortIndex;
 
  vtkWeakPointer<vtkSMSourceProxy> SourceProxy;
  vtkWeakPointer<vtkSMCompoundSourceProxy> CompoundSourceProxy;
 
  vtkPVClassNameInformation* ClassNameInformation;
  int ClassNameInformationValid;
 
  vtkPVDataInformation* DataInformation;
  bool DataInformationValid;
 
  vtkPVTemporalDataInformation* TemporalDataInformation;
  bool TemporalDataInformationValid;
 
  std::map<std::string, std::map<int, vtkSmartPointer<vtkPVDataInformation>>>
    SubsetDataInformations;
  std::map<int, vtkSmartPointer<vtkPVDataInformation>> RankDataInformations;
 
private:
  vtkSMOutputPort(const vtkSMOutputPort&) = delete;
  void operator=(const vtkSMOutputPort&) = delete;
 
  friend class vtkSMSourceProxy;
  friend class vtkSMCompoundSourceProxy;
  void UpdatePipeline();
 
  // Update Pipeline with the given timestep request.
  void UpdatePipeline(double time);
};
 
#endif