QmitkDataStorageTableModel.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

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

#ifndef QmitkDataStorageTableModel_h
#define QmitkDataStorageTableModel_h

#include <MitkQtWidgetsExports.h>

#include "mitkBaseProperty.h"
#include "mitkDataStorage.h"
#include "mitkNodePredicateBase.h"
#include "mitkWeakPointer.h"

#include <QAbstractTableModel>


class MITKQTWIDGETS_EXPORT QmitkDataStorageTableModel : public QAbstractTableModel
{
  Q_OBJECT

  //#Ctors/Dtor
public:
  QmitkDataStorageTableModel(mitk::DataStorage::Pointer _DataStorage,
                             mitk::NodePredicateBase *_Predicate = nullptr,
                             QObject *parent = nullptr);

  ~QmitkDataStorageTableModel() override;

  //# Public GETTER
public:
  const mitk::DataStorage::Pointer GetDataStorage() const;
  mitk::NodePredicateBase::Pointer GetPredicate() const;
  mitk::DataNode::Pointer GetNode(const QModelIndex &index) const;
  QVariant headerData(int section, Qt::Orientation orientation, int role) const override;
  Qt::ItemFlags flags(const QModelIndex &index) const override;
  int rowCount(const QModelIndex &parent) const override;
  int columnCount(const QModelIndex &parent) const override;
  QVariant data(const QModelIndex &index, int role) const override;

  //# Public SETTERS
public:
  void SetDataStorage(mitk::DataStorage::Pointer _DataStorage);
  void SetPredicate(mitk::NodePredicateBase *_Predicate);
  virtual void AddNode(const mitk::DataNode *node);
  virtual void RemoveNode(const mitk::DataNode *node);
  virtual std::vector<mitk::DataNode *> GetNodeSet() const;
  virtual void PropertyModified(const itk::Object *caller, const itk::EventObject &event);
  bool setData(const QModelIndex &index, const QVariant &value, int role) override;
  void sort(int column, Qt::SortOrder order = Qt::AscendingOrder) override;

  //#PROTECTED INNER CLASSES
protected:
  struct DataNodeCompareFunction : public std::binary_function<mitk::DataNode::Pointer, mitk::DataNode::Pointer, bool>
  {
    enum CompareCriteria
    {
      CompareByName = 0,
      CompareByClassName,
      CompareByVisibility
    };

    enum CompareOperator
    {
      Less = 0,
      Greater
    };

    DataNodeCompareFunction(CompareCriteria _CompareCriteria = CompareByName, CompareOperator _CompareOperator = Less);
    bool operator()(const mitk::DataNode::Pointer &_Left, const mitk::DataNode::Pointer &_Right) const;

  protected:
    CompareCriteria m_CompareCriteria;
    CompareOperator m_CompareOperator;
  };

  //#Protected SETTER
protected:
  virtual void Reset();

  //#Protected MEMBER VARIABLES
protected:
  mitk::WeakPointer<mitk::DataStorage> m_DataStorage;
  mitk::NodePredicateBase::Pointer m_Predicate;
  std::vector<mitk::DataNode *> m_NodeSet;
  std::map<mitk::BaseProperty *, unsigned long> m_NamePropertyModifiedObserverTags;
  std::map<mitk::BaseProperty *, unsigned long> m_VisiblePropertyModifiedObserverTags;
  bool m_BlockEvents;
  bool m_SortDescending;
};

#endif