pqOutputPort.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#ifndef pqOutputPort_h
#define pqOutputPort_h

#include "pqCoreModule.h"
#include "pqProxy.h"

class pqDataRepresentation;
class pqPipelineSource;
class pqServer;
class pqView;
class vtkPVDataInformation;
class vtkPVTemporalDataInformation;
class vtkSMOutputPort;
class vtkSMSourceProxy;

class PQCORE_EXPORT pqOutputPort : public pqProxy
{
  Q_OBJECT
  typedef pqProxy Superclass;

public:
  pqOutputPort(pqPipelineSource* source, int portno);
  ~pqOutputPort() override;

  vtkSMOutputPort* getOutputPortProxy() const;

  pqPipelineSource* getSource() const { return this->Source; }

  vtkSMSourceProxy* getSourceProxy() const;

  pqServer* getServer() const;

  int getPortNumber() const { return this->PortNumber; }

  QString getPortName() const;

  int getNumberOfConsumers() const;

  pqPipelineSource* getConsumer(int index) const;

  QList<pqPipelineSource*> getConsumers() const;

  QList<pqDataRepresentation*> getRepresentations(pqView* view) const;

  pqDataRepresentation* getRepresentation(pqView* view) const;

  QList<pqView*> getViews() const;

  vtkPVDataInformation* getDataInformation() const;

  vtkPVDataInformation* getRankDataInformation(int rank) const;

  vtkPVTemporalDataInformation* getTemporalDataInformation();

  vtkPVDataInformation* getSelectedDataInformation(int es_port = 0) const;

  const char* getDataClassName() const;

  vtkSMSourceProxy* getSelectionInput();

  unsigned int getSelectionInputPort();

  void setSelectionInput(vtkSMSourceProxy* src, int port);

  QString prettyName() const;

public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void renderAllViews(bool force = false);

Q_SIGNALS:
  void connectionAdded(pqOutputPort* port, pqPipelineSource* consumer);
  void preConnectionAdded(pqOutputPort* port, pqPipelineSource* consumer);

  void connectionRemoved(pqOutputPort* port, pqPipelineSource* consumer);
  void preConnectionRemoved(pqOutputPort* port, pqPipelineSource* consumer);

  void representationAdded(pqOutputPort* source, pqDataRepresentation* repr);

  void representationRemoved(pqOutputPort* source, pqDataRepresentation* repr);

  void visibilityChanged(pqOutputPort* source, pqDataRepresentation* repr);

protected Q_SLOTS:
  void onRepresentationVisibilityChanged();

protected: // NOLINT(readability-redundant-access-specifiers)
  friend class pqPipelineFilter;
  friend class pqDataRepresentation;

  void removeConsumer(pqPipelineSource*);
  void addConsumer(pqPipelineSource*);

  void addRepresentation(pqDataRepresentation*);
  void removeRepresentation(pqDataRepresentation*);

  pqPipelineSource* Source;
  int PortNumber;

private:
  Q_DISABLE_COPY(pqOutputPort)

  class pqInternal;
  pqInternal* Internal;
};

#endif