lib.nodes.dialogs.BasicDialog Class Reference

BasicDialog action. More...

Inheritance diagram for lib.nodes.dialogs.BasicDialog:

Public Member Functions
def	__attrs_post_init__ (self)
	setup object. More...
def	__call__ (self, resume=False)
	Executes node action. More...
def	continue_seq (self, dialog_result)
	Release the checkbox allowing the Sequencer script to continue its execution. More...
Public Member Functions inherited from lib.nodes.dialogs.Dialog
def	__attrs_post_init__ (self, dialog_type)
def	execute_plugin (self, plugin_method)
	Convenience method to handle synchronous or asynchronous plugins. More...
Public Member Functions inherited from lib.nodes.action.Action
def	make_sequence (self, parent_tpl=None)
	Not much to do here. More...
Public Member Functions inherited from lib.nodes.interface._BaseNode
def	make_sequence (self)
	does nothing More...
def	make_task (self, node, input_list, resume)
	Creates the task object that executes the node. More...
def	pause (self)
def	resume (self)

Static Public Member Functions
def	create (msg, **kw)
	Checkbox node constructor. More...

Public Attributes
	state
Public Attributes inherited from lib.nodes.action.Action
	name
	id
	description
	runtime_flags
	in_error
	t_start
	skip
	t_end
	result
	exception

Static Public Attributes
	name = attr.ib(default=None)
	condition_label = attr.ib(default="No condition")
	step_label = attr.ib(default="No condition")
	check_condition = attr.ib(default=lambda: True)
	condition_extra_step = attr.ib(default=None)
	f = attr.ib(default=None, init=False)
	confirm_seq
	continue_flag = attr.ib(default=None, init=False)
	dialog_message = attr.ib(default=None)
Static Public Attributes inherited from lib.nodes.dialogs.Dialog
	dialog_type = attr.ib(default=None, init=False)
Static Public Attributes inherited from lib.nodes.action.Action
	f = attr.ib(default=None, repr=False)
	parent_tpl = attr.ib(default=None, repr=False)
	current_node = cv.ContextVar("current_node", default=None)
Static Public Attributes inherited from lib.nodes.interface._BaseNode
	id = attr.ib(default=None, kw_only=True)
	name = attr.ib(default=None, kw_only=True)
	runtime_flags = attr.ib(default=0, kw_only=True)
	deps = attr.ib(default=attr.Factory(list), repr=False, kw_only=True, init=False)
	description = attr.ib(default="", kw_only=True)
	exception = attr.ib(init=False, default=None, repr=False)
	can_skip = attr.ib(default=True, init=False)
	hide = attr.ib(default=False, init=False)
	t_start = attr.ib(init=False, default=None, repr=False)
	t_end = attr.ib(init=False, default=None, repr=False)
	running_checkpoint
	serial_number = attr.ib(init=False)

Additional Inherited Members
Properties inherited from lib.nodes.action.Action
	context = property
	Get context from the running Sequence. More...
	state = property
	full_state = property
Properties inherited from lib.nodes.interface._BaseNode
	result = property
	Node's result. More...
	end_node = property
	start_node = property
	state = property
	Gets the node state. More...
	full_state = property
	Gets the node state. More...
	in_error = property
	skip = property

Detailed Description

BasicDialog action.

BasicDialog node waits for user to make a choice

Parameters

msg	Checkbox message
id	Unique id. If not provided an unique identifier is assigned.
name	Node name. If not provided a name is assigned.

Member Function Documentation

__attrs_post_init__()

def lib.nodes.dialogs.BasicDialog.__attrs_post_init__

(

self

)

setup object.

Sets name, id and allows node to run.

Reimplemented from lib.nodes.action.Action.

__call__()

def lib.nodes.dialogs.BasicDialog.__call__	(		self,
			resume = False
	)

Executes node action.

   If the action is a coroutine a task is created and passed to
   the asyncio loop for execution.

Reimplemented from lib.nodes.action.Action.

continue_seq()

def lib.nodes.dialogs.BasicDialog.continue_seq	(		self,
			dialog_result
	)

Release the checkbox allowing the Sequencer script to continue its execution.

create()

def lib.nodes.dialogs.BasicDialog.create (   msg, **  kw  )

static

Checkbox node constructor.

Parameters

msg	Message to display along with the checkbox. *kw: standard sequencer node keywords.
id	Node id
name	node name

Member Data Documentation

check_condition

lib.nodes.dialogs.BasicDialog.check_condition = attr.ib(default=lambda: True)

static

condition_extra_step

lib.nodes.dialogs.BasicDialog.condition_extra_step = attr.ib(default=None)

static

condition_label

lib.nodes.dialogs.BasicDialog.condition_label = attr.ib(default="No condition")

static

confirm_seq

lib.nodes.dialogs.BasicDialog.confirm_seq

static

Initial value:

=  attr.ib(
        init=False, repr=False, default=attr.Factory(asyncio.Event)
    )

continue_flag

lib.nodes.dialogs.BasicDialog.continue_flag = attr.ib(default=None, init=False)

static

dialog_message

lib.nodes.dialogs.BasicDialog.dialog_message = attr.ib(default=None)

static

f

lib.nodes.dialogs.BasicDialog.f = attr.ib(default=None, init=False)

static

name

lib.nodes.dialogs.BasicDialog.name = attr.ib(default=None)

static

state

lib.nodes.dialogs.BasicDialog.state

step_label

lib.nodes.dialogs.BasicDialog.step_label = attr.ib(default="No condition")

static

---

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

• seq/seqlib/src/seq/lib/nodes/dialogs.py