mitkIPropertyRelations.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 mitkIPropertyRelations_h
#define mitkIPropertyRelations_h

#include <mitkPropertyRelationRuleBase.h>
#include <mitkServiceInterface.h>

namespace mitk
{
  class MITKCORE_EXPORT IPropertyRelations
  {
  public:
    virtual ~IPropertyRelations();

    using RuleResultVectorType = std::list<PropertyRelationRuleBase::ConstPointer>;
    using RuleIDType = PropertyRelationRuleBase::RuleIDType;
    using RuleIDVectorType = std::vector<RuleIDType>;

    virtual bool AddRule(const PropertyRelationRuleBase *rule, bool overwrite = false) = 0;

    virtual RuleResultVectorType GetRulesForSource(const IPropertyProvider* source) const = 0;

    virtual RuleResultVectorType GetRulesForSourceCandidate(const IPropertyProvider* sourceCandidate) const = 0;

    virtual RuleResultVectorType GetRulesForDestinationCandidate(const IPropertyProvider* destCandidate) const = 0;

    virtual PropertyRelationRuleBase::ConstPointer GetRule(const RuleIDType &ruleID) const = 0;

    virtual RuleIDVectorType GetRuleIDs() const = 0;

    virtual bool HasRuleForSource(const IPropertyProvider* source) const = 0;

    virtual void RemoveAllRules() = 0;

    virtual void RemoveRule(const RuleIDType &ruleID) = 0;
  };
}

MITK_DECLARE_SERVICE_INTERFACE(mitk::IPropertyRelations, "org.mitk.IPropertyRelations")

#endif