pqPipelineModel.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 pqPipelineModel_h
#define pqPipelineModel_h

#include "pqComponentsModule.h" // For export macro
#include "pqView.h"             // For View

#include <QAbstractItemModel>
#include <QMap>     // For PixmapMap
#include <QPointer> // For View

class ModifiedLiveInsituLink;
class QFont;
class QPixmap;
class QString;
class pqExtractor;
class pqPipelineModelDataItem;
class pqPipelineModelInternal;
class pqPipelineSource;
class pqServer;
class pqServerManagerModel;
class pqServerManagerModelItem;
class vtkSession;

class PQCOMPONENTS_EXPORT pqPipelineModel : public QAbstractItemModel
{
  Q_OBJECT;

public:
  enum ItemType
  {
    Invalid = -1,
    Server = 0,
    Proxy,
    Port,
    Extractor,
    Link
  };

  enum ItemRole
  {
    AnnotationFilterRole = 33,
    SessionFilterRole = 34
  };

  pqPipelineModel(QObject* parent = nullptr);

  pqPipelineModel(const pqPipelineModel& other, QObject* parent = nullptr);

  pqPipelineModel(const pqServerManagerModel& other, QObject* parent = nullptr);

  ~pqPipelineModel() override;


  int rowCount(const QModelIndex& parent = QModelIndex()) const override;

  int columnCount(const QModelIndex& parent = QModelIndex()) const override;

  bool hasChildren(const QModelIndex& parent = QModelIndex()) const override;

  QModelIndex index(int row, int column, const QModelIndex& parent = QModelIndex()) const override;

  QModelIndex parent(const QModelIndex& index) const override;

  QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override;

  bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole) override;

  Qt::ItemFlags flags(const QModelIndex& index) const override;


  pqServerManagerModelItem* getItemFor(const QModelIndex&) const;

  QModelIndex getIndexFor(pqServerManagerModelItem* item) const;

  ItemType getTypeFor(const QModelIndex& index) const;

  bool isEditable() const { return this->Editable; }

  void setEditable(bool editable) { this->Editable = editable; }

  void setSelectable(const QModelIndex& index, bool selectable);

  bool isSelectable(const QModelIndex& index) const;

  void setSubtreeSelectable(pqServerManagerModelItem* item, bool selectable);

  QModelIndex getNextIndex(QModelIndex index, const QModelIndex& root = QModelIndex()) const;

  pqView* view() const { return this->View; }

  void setModifiedFont(const QFont& font);

  void enableFilterAnnotationKey(const QString& expectedAnnotation);

  void disableFilterAnnotationKey();

  void setAnnotationFilterMatching(bool matching);

  void enableFilterSession(vtkSession* session);

  void disableFilterSession();

public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void addServer(pqServer* server);

  void removeServer(pqServer* server);

  void addSource(pqPipelineSource* source);

  void removeSource(pqPipelineSource* source);

  void addConnection(pqPipelineSource* source, pqPipelineSource* sink, int);

  void removeConnection(pqPipelineSource* source, pqPipelineSource* sink, int);


  void addConnection(pqServerManagerModelItem* source, pqExtractor* sink);
  void removeConnection(pqServerManagerModelItem* source, pqExtractor* sink);


  void addExtractor(pqExtractor*);
  void removeExtractor(pqExtractor*);

  void setView(pqView* module);

Q_SIGNALS:
  void firstChildAdded(const QModelIndex& index);
  void childWithChildrenAdded(const QModelIndex& index);

private Q_SLOTS:
  void onInsituConnectionInitiated(pqServer* server);

  void serverDataChanged();

  void updateVisibility(pqPipelineSource*, ItemType type = Proxy);

  void delayedUpdateVisibility(pqPipelineSource*);
  void delayedUpdateVisibilityTimeout();

  void updateData(pqServerManagerModelItem*, ItemType type = Proxy);
  void updateDataServer(pqServer* server);

private: // NOLINT(readability-redundant-access-specifiers)
  friend class pqPipelineModelDataItem;

  // Add an item as a child under the parent at the given index.
  // Note that this method does not actually change the underlying
  // pqServerManagerModel, it merely signals that such an addition
  // has taken place.
  void addChild(pqPipelineModelDataItem* parent, pqPipelineModelDataItem* child);

  // Remove a child item from under the parent.
  // Note that this method does not actually change the underlying
  // pqServerManagerModel, it merely signals that such an addition
  // has taken place.
  void removeChildFromParent(pqPipelineModelDataItem* child);

  // Returns the pqPipelineModelDataItem for the given pqServerManagerModelItem.
  pqPipelineModelDataItem* getDataItem(pqServerManagerModelItem* item,
    pqPipelineModelDataItem* subtreeRoot, ItemType type = Invalid) const;

  // called by pqPipelineModelDataItem to indicate that the data for the item
  // may have changed.
  void itemDataChanged(pqPipelineModelDataItem*);
  void setSubtreeSelectable(pqPipelineModelDataItem* item, bool selectable);

  QModelIndex getIndex(pqPipelineModelDataItem* item) const;

  bool checkAndLoadPipelinePixmap(const QString& iconType);

  pqPipelineModelInternal* Internal; 
  QMap<QString, QPixmap> PixmapMap;  
  QPointer<pqView> View;
  bool Editable;
  bool FilterAnnotationMatching;
  QString FilterRoleAnnotationKey;
  vtkSession* FilterRoleSession;
  ModifiedLiveInsituLink* LinkCallback;
  void constructor();

  friend class ModifiedLiveInsituLink;
};

#endif