seq  4.0.0-pre3
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lib.nodes.recover.RLoop Class Reference

My RLoop Class. More...

Inheritance diagram for lib.nodes.recover.RLoop:
lib.nodes.loop.Loop lib.nodes.sequence.Sequence lib.nodes.interface._BaseNode

Public Member Functions

def __attrs_post_init__ (self)
 Assigns node's name and id. More...
 
def make_task (self, node, input_list, resume)
 Creates the task object that executes the node. More...
 
- Public Member Functions inherited from lib.nodes.loop.Loop
def end_step (self)
 Standard Loop's end step. More...
 
def make_sequence (self, parent_tpl=None)
 Creates the Loop execution graph. More...
 
def set_block (self, *args)
 Assigns the sequence to the loop's block. More...
 
def nodes (self)
 Return nodes from Graph. More...
 
def get_node (self, node_id)
 Get node by id. More...
 
- Public Member Functions inherited from lib.nodes.sequence.Sequence
def __iter__ (self)
 
def start_step (self)
 Standard sequence's start step. More...
 
def append (self, s)
 Appends a node to the Sequence. More...
 
def create_node_tasks (self, resume=False)
 Creates Task object associated to this node. More...
 
def reschedule_node (self, node_id)
 Reschedule a node for execution. More...
 
def start (self, make_sequence=True, resume=False)
 This is the entry point for Sequence execution. More...
 
def run (self)
 Runs the node – This executes the task. More...
 
def execute (self, resume=False, propagate=False)
 Executes this just creates the asyncio task. More...
 
def resume (self)
 Resume node execution. More...
 
def main_task (self)
 Returns the objective node of the sequence – the end node. More...
 
def __call__ (self, resume=False)
 
def abort (self)
 Aborts the sequence. More...
 
def get_task (self, node_id)
 Get task by node_id. More...
 
def par (self, k)
 Get a parameter value. More...
 
def set (self, p)
 Sets the value of a parameter. More...
 
- Public Member Functions inherited from lib.nodes.interface._BaseNode
def make_sequence (self)
 does nothing More...
 
def pause (self)
 

Static Public Member Functions

def create (source, *args, **kw)
 source (Sequence or Action): xxx recovery (Sequence or Action): xxx More...
 
- Static Public Member Functions inherited from lib.nodes.loop.Loop
def create (*args, **kw)
 Creates a :class:Loop node. More...
 
- Static Public Member Functions inherited from lib.nodes.sequence.Sequence
def get_context ()
 

Public Attributes

 name
 
- Public Attributes inherited from lib.nodes.loop.Loop
 name
 
 state
 
 in_error
 
 runtime_flags
 
- Public Attributes inherited from lib.nodes.sequence.Sequence
 name
 
 id
 
 in_error
 
 runtime_flags
 
 t_start
 
 skip
 
 exception
 
 t_end
 

Static Public Attributes

 max_retry = attr.ib(default=1, kw_only=True)
 
 err_tbl = attr.ib(default=dict(), kw_only=True, repr=False)
 
- Static Public Attributes inherited from lib.nodes.loop.Loop
 block_args = attr.ib(kw_only=True, default=attr.Factory(list), repr=False)
 
 condition = attr.ib(kw_only=True, default=None, repr=False)
 
 init = attr.ib(kw_only=True, default=None, repr=False)
 
 block = attr.ib(init=False, default=None, repr=False)
 
 node_value = attr.ib(init=False, default=0, repr=False)
 
 parent_tpl = attr.ib(default=None, repr=False)
 
 index = cv.ContextVar("index", default=0)
 
- Static Public Attributes inherited from lib.nodes.sequence.Sequence
 graph = attr.ib(init=False, default=attr.Factory(nx.DiGraph), repr=False)
 
 debug = attr.ib(init=False, default=False, repr=False)
 
 current_seq = cv.ContextVar("current_seq", default=None)
 
 root = cv.ContextVar("root", 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.sequence.Sequence
 context = property
 Get context dictionary, preferably from root node. More...
 
 seq = property
 Retrieves the sequence list. More...
 
 G = property
 returns the graph object More...
 
 start_node = property
 Returns the start node. More...
 
 end_node = property
 Returns the end node. More...
 
 parameters = property
 Return parameters. More...
 
 state = property
 node state More...
 
 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

My RLoop Class.

    id (Optional str): Node id.
    name (Optional str): Node name.
Parameters
initInitialization node.
conditionA Python method that returns a boolean value.

Member Function Documentation

◆ __attrs_post_init__()

def lib.nodes.recover.RLoop.__attrs_post_init__ (   self)

Assigns node's name and id.

Reimplemented from lib.nodes.loop.Loop.

◆ create()

def lib.nodes.recover.RLoop.create (   source,
args,
**  kw 
)
static

source (Sequence or Action): xxx recovery (Sequence or Action): xxx

        **kw: Same as Loop's constructor.
Returns
A new :class:Recover object

◆ make_task()

def lib.nodes.recover.RLoop.make_task (   self,
  node,
  input_list,
  resume 
)

Creates the task object that executes the node.

Reimplemented from lib.nodes.loop.Loop.

Member Data Documentation

◆ err_tbl

lib.nodes.recover.RLoop.err_tbl = attr.ib(default=dict(), kw_only=True, repr=False)
static

◆ max_retry

lib.nodes.recover.RLoop.max_retry = attr.ib(default=1, kw_only=True)
static

◆ name

lib.nodes.recover.RLoop.name

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