QmitkAbstractSemanticRelationsStorageModel.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 QMITKABSTRACTSEMANTICRELATIONSSTORAGEMODEL_H
#define QMITKABSTRACTSEMANTICRELATIONSSTORAGEMODEL_H

// mitk semantic relations UI
#include "MitkSemanticRelationsUIExports.h"

// semantic relations module
#include <mitkISemanticRelationsObserver.h>
#include <mitkSemanticRelationsDataStorageAccess.h>
#include <mitkSemanticRelationsIntegration.h>
#include <mitkSemanticTypes.h>

// qt widgets module
#include "QmitkAbstractDataStorageModel.h"

/*
* @brief The QmitkAbstractSemanticRelationsStorageModel is a subclass of 'QmitkAbstractDataStorageModel' and provides additional
*        functionality to set and store a semantic relations instance, the current case ID and the current lesion.
*/
class MITKSEMANTICRELATIONSUI_EXPORT QmitkAbstractSemanticRelationsStorageModel : public QmitkAbstractDataStorageModel, public mitk::ISemanticRelationsObserver
{
  Q_OBJECT

public:

  QmitkAbstractSemanticRelationsStorageModel(QObject* parent = nullptr);
  ~QmitkAbstractSemanticRelationsStorageModel() override;

  /*
  * @brief Update this model with the data from the semantic relations,
  *        if the case ID is equal to the currently selected case ID of the table model.
  *
  *       Overridden from 'ISemanticRelationsObserver'.
  *       In order for the Update-function to be called, this model has to be added as an observer of SemanticRelation
  *       (e.g. m_SemanticRelations->AddObserver(m_SemanticRelationsStorageModel);)
  *
  * @par caseID    The current case ID to identify the currently active patient / case.
  */
  void Update(const mitk::SemanticTypes::CaseID& caseID) override;

  void SetCaseID(const mitk::SemanticTypes::CaseID& caseID);

  const mitk::SemanticTypes::CaseID& GetCaseID() const { return m_CaseID; }
  void SetLesion(const mitk::SemanticTypes::Lesion& lesion);

  const mitk::SemanticTypes::Lesion& GetLesion() const { return m_Lesion; }
  void SetDataNodeSelection(const QList<mitk::DataNode::Pointer>& dataNodeSelection);

  const QList<mitk::DataNode::Pointer>& GetSelectedDataNodes() const { return m_SelectedDataNodes; };
  /*
  * @brief Update the semantic relations storage model with the current data from the semantic relations model
  *        and the current case ID.
  */
  void UpdateModelData();

Q_SIGNALS:
  void ModelUpdated();

protected:

  void DataStorageChanged() override;

  virtual void SetData() = 0;

  std::unique_ptr<mitk::SemanticRelationsDataStorageAccess> m_SemanticRelationsDataStorageAccess;
  std::unique_ptr<mitk::SemanticRelationsIntegration> m_SemanticRelationsIntegration;

  mitk::SemanticTypes::CaseID m_CaseID;
  QList<mitk::DataNode::Pointer> m_SelectedDataNodes;
  mitk::SemanticTypes::Lesion m_Lesion;
};

#endif // QMITKABSTRACTSEMANTICRELATIONSSTORAGEMODEL_H