lib.nodes.checkbox.Checkbox Class Reference

Checkbox ctor. More...

Inheritance diagram for lib.nodes.checkbox.Checkbox:

Public Member Functions
def	__attrs_post_init__ (self)
	setup object. More...
def	__call__ (self, resume=False)
	Executes node action. More...
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	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
	name
	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
	f = attr.ib(default=None, init=False)
	checkmark
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

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

)

setup object.

Sets name, id and allows node to run.

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