mitkSourceImageRelationRule.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 MITK_SOURCE_IMAGE_RELATION_RULE_H
#define MITK_SOURCE_IMAGE_RELATION_RULE_H

#include "mitkPropertyRelationRuleBase.h"
#include "mitkImage.h"

namespace mitk
{
  class MITKCORE_EXPORT SourceImageRelationRule : public mitk::PropertyRelationRuleBase
  {
  public:
    mitkClassMacro(SourceImageRelationRule, PropertyRelationRuleBase);
    itkNewMacro(Self);
    mitkNewMacro1Param(Self, const RuleIDType &);
    mitkNewMacro2Param(Self, const RuleIDType &, const std::string &);
    mitkNewMacro4Param(Self, const RuleIDType &, const std::string &, const std::string &, const std::string &);

    using RuleIDType = PropertyRelationRuleBase::RuleIDType;
    using RelationUIDType = PropertyRelationRuleBase::RelationUIDType;
    using RelationUIDVectorType = PropertyRelationRuleBase::RelationUIDVectorType;

    RuleIDType GetRuleID() const override;

    bool IsAbstract() const override;

    std::string GetDisplayName() const override;

    std::string GetSourceRoleName() const override;
    std::string GetDestinationRoleName() const override;

    bool IsDestinationCandidate(const IPropertyProvider *owner) const override;

    RelationUIDType Connect(Image *source, const Image *destination) const;

  protected:
    SourceImageRelationRule();
    SourceImageRelationRule(const RuleIDType &purposeTag);
    SourceImageRelationRule(const RuleIDType &purposeTag, const std::string &displayName);
    SourceImageRelationRule(const RuleIDType &purposeTag,
                          const std::string &displayName,
                          const std::string &sourceRole,
                          const std::string &destinationRole);
    ~SourceImageRelationRule() override = default;

    using InstanceIDType = PropertyRelationRuleBase::InstanceIDType;
    using InstanceIDVectorType = PropertyRelationRuleBase::InstanceIDVectorType;

    std::vector<std::pair<size_t, std::string> > GetReferenceSequenceIndices(const IPropertyProvider * source,
      const IPropertyProvider* destination = nullptr, InstanceIDVectorType ignoreInstances = {}) const;

    using DataRelationUIDVectorType = PropertyRelationRuleBase::DataRelationUIDVectorType;
    virtual DataRelationUIDVectorType GetRelationUIDs_DataLayer(const IPropertyProvider* source,
      const IPropertyProvider* destination, const InstanceIDVectorType& instances_IDLayer) const override;

    void Connect_datalayer(IPropertyOwner *source,
                                   const IPropertyProvider *destination,
                                   const InstanceIDType &instanceID) const override;

    void Disconnect_datalayer(IPropertyOwner *source, const RelationUIDType& relationUID) const override;

    bool IsSupportedRuleID(const RuleIDType& ruleID) const override;

    itk::LightObject::Pointer InternalClone() const override;

    PropertyKeyPath::ItemSelectionIndex CreateNewSourceImageSequenceItem(IPropertyOwner *source) const;

    std::string GenerateRuleID(const std::string& purpose) const;

  private:
    RuleIDType m_PurposeTag;
    std::string m_DisplayName;
    std::string m_SourceRole;
    std::string m_DestinationRole;
  };

} // namespace mitk

#endif