Add documentation for createExtruderTrain

Contributes to issues CURA-340 and CURA-1278.
This commit is contained in:
Ghostkeeper 2016-06-08 13:59:26 +02:00
parent fffe9b3a94
commit 0a34577fdb
No known key found for this signature in database
GPG key ID: 701948C5954A7385

View file

@ -91,6 +91,20 @@ class ExtruderManager(QObject):
if extruder_trains: if extruder_trains:
self.extrudersChanged.emit(machine_definition) self.extrudersChanged.emit(machine_definition)
## Creates a container stack for an extruder train.
#
# The container stack has an extruder definition at the bottom, which is
# linked to a machine definition. Then it has a nozzle profile, a material
# profile, a quality profile and a user profile, in that order.
#
# The resulting container stack is added to the registry.
#
# \param extruder_definition The extruder to create the extruder train
# for.
# \param machine_definition The machine that the extruder train belongs
# to.
# \param position The position of this extruder train in the extruder
# slots of the machine.
def createExtruderTrain(self, extruder_definition, machine_definition, position): def createExtruderTrain(self, extruder_definition, machine_definition, position):
#Cache some things. #Cache some things.
container_registry = UM.Settings.ContainerRegistry.getInstance() container_registry = UM.Settings.ContainerRegistry.getInstance()