pqOutputPort.h

Go to the documentation of this file.

/*=========================================================================

   Program: ParaView
   Module:    pqOutputPort.h

   Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

========================================================================*/
#ifndef pqOutputPort_h
#define pqOutputPort_h

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

class pqDataRepresentation;
class pqPipelineSource;
class pqServer;
class pqView;
class vtkDataAssembly;
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;

  vtkPVTemporalDataInformation* getTemporalDataInformation();

  vtkPVDataInformation* getSelectedDataInformation(int es_port = 0) const;

  const char* getDataClassName() const;

  vtkSMSourceProxy* getSelectionInput();

  unsigned int getSelectionInputPort();

  void setSelectionInput(vtkSMSourceProxy* src, int port);

  vtkDataAssembly* dataAssembly() const;

public Q_SLOTS:
  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:
  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