seq  2.0.0
Public Member Functions | List of all members
lib.nodes.action.ActionInThread Class Reference

ActionInThread ctor. More...

Inheritance diagram for lib.nodes.action.ActionInThread:
lib.nodes.action.Action lib.nodes.interface._BaseNode

Public Member Functions

def __call__ (self, resume=False)
 
- Public Member Functions inherited from lib.nodes.action.Action
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...
 
- 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)
 

Additional Inherited Members

- Public Attributes inherited from lib.nodes.action.Action
 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 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(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

ActionInThread ctor.

ActionInThread nodes executes python callables (functions or methods) in a Sequencer script.

Parameters
fThe callable the node will execute
idUnique id. If not provided an unique identifier is assigned.
nameNode name. If not provided a name is assigned.
Exceptions
TypeExceptionis f is not a python method or function.

Member Function Documentation

◆ __call__()

def lib.nodes.action.ActionInThread.__call__ (   self,
  resume = False 
)
Executes node action.

The action is a normal function, a special task is created
in order to execute the action in a different thread.

In any case the context parameter is passed to the action and
its result saved.

Reimplemented from lib.nodes.action.Action.


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