Scheme Node (node
)¶
Scheme Node¶
- class orangecanvas.scheme.node.SchemeNode(description, title=None, position=None, properties=None, parent=None)[source]¶
Bases:
PyQt5.QtCore.QObject
A node in a
Scheme
.- Parameters
description (
WidgetDescription
) – Node description instance.title (str, optional) – Node title string (if None description.name is used).
position (tuple) – (x, y) tuple of floats for node position in a visual display.
properties (dict) – Additional extra instance properties (settings, widget geometry, …)
parent (
QObject
) – Parent object.
- title_changed(title)¶
The title of the node has changed
- position_changed((x, y))¶
Position of the node in the scheme has changed
- progress_changed(progress)¶
Node’s progress value has changed.
- processing_state_changed(state)¶
Node’s processing state has changed.
- class State(value)[source]¶
Bases:
enum.IntEnum
A workflow node’s runtime state flags
- NoState = 0¶
The node has no state.
- Running = 1¶
The node is running (i.e. executing a task).
- Pending = 2¶
The node has invalidated inputs. This flag is set when:
An input link is added or removed
An input link is marked as pending
It is set/cleared by the execution manager when the inputs are propagated to the node.
- Invalidated = 4¶
The node has invalidated outputs. Execution manager should not propagate this node’s existing outputs to dependent nodes until this flag is cleared.
- NotReady = 8¶
The node is in a state where it does not accept new signals. The execution manager should not propagate inputs to this node until this flag is cleared.
- input_channel(name)[source]¶
Return the input channel matching name. Raise a ValueError if not found.
- output_channel(name)[source]¶
Return the output channel matching name. Raise an ValueError if not found.
- status_message_changed¶
The node’s status tip has changes
- state_message_changed¶
The node’s state message has changed
- clear_state_message(message_id)[source]¶
Clear (remove) a message with message_id.
state_message_changed
signal will be emitted with a empty message for the message_id.
- state_message(message_id)[source]¶
Return a message with message_id or None if a message with that id does not exist.
- set_state(state)[source]¶
Set the node runtime state flags
- Parameters
state (SchemeNode.State) –
- set_state_flags(flags, on)[source]¶
Set the specified state flags on/off.
- Parameters
flags (SchemeNode.State) – Flag to modify
on (bool) – Turn the flag on or off
- test_state_flags(flag)[source]¶
Return True/False if the runtime state flag is set.
- Parameters
flag (SchemeNode.State) –
- Returns
val
- Return type