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

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

Public Member Functions

def __init__
 Constructor. More...
 
def __hash__ (self)
 Ensure that the SettingRelation is hashable, so it can be used in a set. More...
 
def owner (self)
 The owner of this relation. More...
 
def target (self)
 The target of this relation. More...
 
def type (self)
 The type of this relation. More...
 
def role (self)
 The role of this relation. More...
 
def __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

def UM.Settings.SettingRelation.SettingRelation.__init__ (   self,
  owner 
)

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.

Member Function Documentation

def UM.Settings.SettingRelation.SettingRelation.__hash__ (   self)

Ensure that the SettingRelation is hashable, so it can be used in a set.

def UM.Settings.SettingRelation.SettingRelation.owner (   self,
  SettingDefinition 
)

The owner of this relation.

def UM.Settings.SettingRelation.SettingRelation.role (   self,
  str 
)

The role of this relation.

def UM.Settings.SettingRelation.SettingRelation.target (   self,
  SettingDefinition 
)

The target of this relation.

def UM.Settings.SettingRelation.SettingRelation.type (   self,
  RelationType 
)

The type of this relation.


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