lib.nodes.action.Action Class Reference

Action ctor. More...

Inheritance diagram for lib.nodes.action.Action:

Public Member Functions
def	__attrs_post_init__ (self)
def	context (self)
	Get context from the running Sequence. More...
def	publish_state (self)
	Requests controller object to publish node's state. More...
def	state (self)
	Gets the node state. More...
def	state (self, value)
	Sets the node state. More...
def	__call__ (self, resume=False)
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_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)

Public Attributes
	name
	id
	serial_number
	description
	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, repr=False)
Static Public Attributes inherited from lib.nodes.interface._BaseNode
	serial_number = attr.ib(default=0, kw_only=True)
	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

Action ctor.

Action nodes executes coroutines in a Sequencer script.

Parameters

f	The coroutine the node will execute
id	Unique id. If not provided an unique identifier is assigned.
name	Node name. If not provided a name is assigned.

Exceptions

TypeException

is f is not a coroutine.

Member Function Documentation

__attrs_post_init__()

def lib.nodes.action.Action.__attrs_post_init__

(

self

)

__call__()

def lib.nodes.action.Action.__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 in lib.nodes.action.ActionInThread.

context()

def lib.nodes.action.Action.context

(

self

)

Get context from the running Sequence.

publish_state()

def lib.nodes.action.Action.publish_state

(

self

)

Requests controller object to publish node's state.

state() [1/2]

def lib.nodes.action.Action.state

(

self

)

Gets the node state.

Reimplemented from lib.nodes.interface._BaseNode.

state() [2/2]

def lib.nodes.action.Action.state	(		self,
			value
	)

Sets the node state.

Reimplemented from lib.nodes.interface._BaseNode.

Member Data Documentation

description

lib.nodes.action.Action.description

exception

lib.nodes.action.Action.exception

f

lib.nodes.action.Action.f = attr.ib(default=None, repr=False)

static

id

lib.nodes.action.Action.id

in_error

lib.nodes.action.Action.in_error

name

lib.nodes.action.Action.name

result

lib.nodes.action.Action.result

serial_number

lib.nodes.action.Action.serial_number

skip

lib.nodes.action.Action.skip

state

lib.nodes.action.Action.state

logger.info("PREAMBLE ...: %s -- %d", self.name, self.runtime_flags)

t_end

lib.nodes.action.Action.t_end

t_start

lib.nodes.action.Action.t_start

---

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

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