Interface of property relations service. More...
#include <mitkIPropertyRelations.h>
Public Types | |
| using | RuleResultVectorType = std::list< PropertyRelationRuleBase::ConstPointer > |
| using | RuleIDType = PropertyRelationRuleBase::RuleIDType |
| using | RuleIDVectorType = std::vector< RuleIDType > |
Public Member Functions | |
| virtual | ~IPropertyRelations () |
| virtual bool | AddRule (const PropertyRelationRuleBase *rule, bool overwrite=false)=0 |
| Add rule for a specific relation. If there is already a property rule instance it won't be added. Rule instances are regarded equal, if the rule ID is equal. You may enforce to overwrite the old equal rule by the overwrite parameter. More... | |
| virtual RuleResultVectorType | GetRulesForSource (const IPropertyProvider *source) const =0 |
| Get all relation rules the passed source is really a source of. (PropertyRelationRuleBase::IsSource() would return true) More... | |
| virtual RuleResultVectorType | GetRulesForSourceCandidate (const IPropertyProvider *sourceCandidate) const =0 |
| Get all relation rules that would accept the passed IPropertOwner as source. More... | |
| virtual RuleResultVectorType | GetRulesForDestinationCandidate (const IPropertyProvider *destCandidate) const =0 |
| Get all relation rules that would accept the passed IPropertOwner as destination. More... | |
| virtual PropertyRelationRuleBase::ConstPointer | GetRule (const RuleIDType &ruleID) const =0 |
| Get the relation rule that has the specified ruleID. More... | |
| virtual RuleIDVectorType | GetRuleIDs () const =0 |
| Get all IDs of registered rules. More... | |
| virtual bool | HasRuleForSource (const IPropertyProvider *source) const =0 |
| Check if a passed instance has defined relation covered by the registered rules. More... | |
| virtual void | RemoveAllRules ()=0 |
| Remove all relation rules. More... | |
| virtual void | RemoveRule (const RuleIDType &ruleID)=0 |
| Remove relation rule instance with the passed ID. If rule does not exist nothing happens. More... | |
Detailed Description
Interface of property relations service.
This service allows you to manage relations between property provider based on properties. Property relations are managed by rule classes derived from PropertyRelationRuleBase.
Definition at line 28 of file mitkIPropertyRelations.h.
Member Typedef Documentation
◆ RuleIDType
Definition at line 34 of file mitkIPropertyRelations.h.
◆ RuleIDVectorType
| using mitk::IPropertyRelations::RuleIDVectorType = std::vector<RuleIDType> |
Definition at line 35 of file mitkIPropertyRelations.h.
◆ RuleResultVectorType
| using mitk::IPropertyRelations::RuleResultVectorType = std::list<PropertyRelationRuleBase::ConstPointer> |
Definition at line 33 of file mitkIPropertyRelations.h.
Constructor & Destructor Documentation
◆ ~IPropertyRelations()
|
virtual |
Member Function Documentation
◆ AddRule()
|
pure virtual |
Add rule for a specific relation. If there is already a property rule instance it won't be added. Rule instances are regarded equal, if the rule ID is equal. You may enforce to overwrite the old equal rule by the overwrite parameter.
- Parameters
-
[in] rule Relation rule of the property. [in] overwrite Overwrite already existing relation rule.
- Returns
- True if relation rule was added successfully.
Implemented in mitk::PropertyRelations.
◆ GetRule()
|
pure virtual |
Get the relation rule that has the specified ruleID.
- Returns
- Property relation rule or null pointer, if no relation rule is available.
Implemented in mitk::PropertyRelations.
◆ GetRuleIDs()
|
pure virtual |
Get all IDs of registered rules.
Implemented in mitk::PropertyRelations.
◆ GetRulesForDestinationCandidate()
|
pure virtual |
Get all relation rules that would accept the passed IPropertOwner as destination.
- Parameters
-
[in] destCandidate Pointer to the instance that should be checked to be a suitable destination.
- Returns
- Property relation rules or empty list if no relation rules are available.
Implemented in mitk::PropertyRelations.
◆ GetRulesForSource()
|
pure virtual |
Get all relation rules the passed source is really a source of. (PropertyRelationRuleBase::IsSource() would return true)
- Parameters
-
[in] source Pointer to the instance that should be checked as source for the searched rules.
- Returns
- Property relation rules or empty list if no relation rules are available.
Implemented in mitk::PropertyRelations.
◆ GetRulesForSourceCandidate()
|
pure virtual |
Get all relation rules that would accept the passed IPropertOwner as source.
- Parameters
-
[in] sourceCandidate Pointer to the instance that should be checked to be a suitable source.
- Returns
- Property relation rules or empty list if no relation rules are available.
Implemented in mitk::PropertyRelations.
◆ HasRuleForSource()
|
pure virtual |
Check if a passed instance has defined relation covered by the registered rules.
- Parameters
-
[in] source Pointer to the instance that should be checked as source for the searched rules.
- Returns
- True if the property has relations of registered rules, false otherwise.
Implemented in mitk::PropertyRelations.
◆ RemoveAllRules()
|
pure virtual |
Remove all relation rules.
Implemented in mitk::PropertyRelations.
◆ RemoveRule()
|
pure virtual |
Remove relation rule instance with the passed ID. If rule does not exist nothing happens.
Implemented in mitk::PropertyRelations.
The documentation for this class was generated from the following file:
