lib.nodes.checkbox.Checkbox Class Reference

Checkbox ctor. More...

Inheritance diagram for lib.nodes.checkbox.Checkbox:

Public Member Functions
def	__attrs_post_init__ (self)
def	__call__ (self, resume=False)
def	checked (self)
	Release the checkbox allowing the Sequencer script to continue its execution. More...
Public Member Functions inherited from lib.nodes.action.Action
def	context (self)
	Get context from the running Sequence. More...
def	state (self)
	Gets the node state. More...
def	state (self, value)
	Sets the node state. More...
def	make_sequence (self)
	Builds this sequence execution graph. More...
Public Member Functions inherited from lib.nodes.interface._BaseNode
def	result (self)
	Node's result. More...
def	result (self, val)
def	end_node (self)
def	start_node (self)
def	full_state (self)
	Gets the node state. More...
def	in_error (self)
def	skip (self)
def	skip (self, flag=True)
def	in_error (self, flag=True)
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
	name
	state
Public Attributes inherited from lib.nodes.action.Action
	name
	id
	description
	runtime_flags
	state
	logger.info("PREAMBLE ...: %s -- %d", self.name, self.runtime_flags) More...
	t_start
	skip
	t_end
	result
	in_error
	exception

Static Public Attributes
	f = attr.ib(default=None, init=False)
	checkmark
Static Public Attributes inherited from lib.nodes.action.Action
	f = attr.ib(default=None, repr=False)
Static Public Attributes inherited from lib.nodes.interface._BaseNode
	serial_number = attr.ib( kw_only=True, default=attr.Factory(Counter.new_value))
	id = attr.ib(default=None, kw_only=True)
	name = attr.ib(default=None, kw_only=True)
	runtime_flags = attr.ib(default=0, init=False)
	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

Detailed Description

Checkbox ctor.

Checkbox node waits for user to confirm some condition.

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.checkbox.Checkbox.__attrs_post_init__

(

self

)

Reimplemented from lib.nodes.action.Action.

__call__()

def lib.nodes.checkbox.Checkbox.__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.

checked()

def lib.nodes.checkbox.Checkbox.checked

(

self

)

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

create()

def lib.nodes.checkbox.Checkbox.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

checkmark

lib.nodes.checkbox.Checkbox.checkmark

static

Initial value:

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

f

lib.nodes.checkbox.Checkbox.f = attr.ib(default=None, init=False)

static

name

lib.nodes.checkbox.Checkbox.name

state

lib.nodes.checkbox.Checkbox.state

---

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

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