Uranium
Application Framework
UM.Settings.SettingRelation.SettingRelation Class Reference

A representation of a relationship between two settings. More...

Public Member Functions

None __init__ (self, SettingDefinition owner, SettingDefinition target, RelationType relation_type, str role)
 Constructor. More...
 
def __hash__ (self)
 Ensure that the SettingRelation is hashable, so it can be used in a set.
 
SettingDefinition owner (self)
 The owner of this relation.
 
SettingDefinition target (self)
 The target of this relation.
 
RelationType type (self)
 The type of this relation.
 
str role (self)
 The role of this relation.
 
str __repr__ (self)
 

Detailed Description

A representation of a relationship between two settings.

This is a simple class representing a relationship between two settings. One of the settings is the "owner", which means it contains the setting, the other setting is the "target", the setting the relation is pointing at. Relations have a type and a role. The type determines in what direction this relation is, the role what property it is used for.

Note
SettingRelation objects are usually created by DefinitionContainer after constructing SettingDefinition objects.

Constructor & Destructor Documentation

◆ __init__()

None UM.Settings.SettingRelation.SettingRelation.__init__ (   self,
SettingDefinition  owner,
SettingDefinition  target,
RelationType  relation_type,
str  role 
)

Constructor.

Parameters
ownerSettingDefinition The object that owns this relation.
targetSettingDefinition The target of the relation.
typeRelationType The type of the relation.
rolestring The role of the relation, what property is it used for.

The documentation for this class was generated from the following file: