lib.nodes.interface._BaseNode Class Reference

Base class for all sequence nodes. More...

Inheritance diagram for lib.nodes.interface._BaseNode:

Public Member Functions
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 Attributes
	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)

Properties
	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

Base class for all sequence nodes.

Parameters

id	Unique Node id, automatically generateed if not given.
name	Node name.

Member Function Documentation

make_sequence()

def lib.nodes.interface._BaseNode.make_sequence

(

self

)

does nothing

make_task()

def lib.nodes.interface._BaseNode.make_task	(		self,
			node,
			input_list,
			resume
	)

Creates the task object that executes the node.

Reimplemented in lib.nodes.recover.RLoop, and lib.nodes.loop.Loop.

pause()

def lib.nodes.interface._BaseNode.pause

(

self

)

resume()

def lib.nodes.interface._BaseNode.resume

(

self

)

Reimplemented in lib.nodes.sequence.Sequence.

Member Data Documentation

can_skip

lib.nodes.interface._BaseNode.can_skip = attr.ib(default=True, init=False)

static

deps

lib.nodes.interface._BaseNode.deps = attr.ib(default=attr.Factory(list), repr=False, kw_only=True, init=False)

static

description

lib.nodes.interface._BaseNode.description = attr.ib(default="", kw_only=True)

static

exception

lib.nodes.interface._BaseNode.exception = attr.ib(init=False, default=None, repr=False)

static

hide

lib.nodes.interface._BaseNode.hide = attr.ib(default=False, init=False)

static

id

lib.nodes.interface._BaseNode.id = attr.ib(default=None, kw_only=True)

static

name

lib.nodes.interface._BaseNode.name = attr.ib(default=None, kw_only=True)

static

running_checkpoint

lib.nodes.interface._BaseNode.running_checkpoint

static

Initial value:

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

runtime_flags

lib.nodes.interface._BaseNode.runtime_flags = attr.ib(default=0, kw_only=True)

static

serial_number

lib.nodes.interface._BaseNode.serial_number = attr.ib(init=False)

static

t_end

lib.nodes.interface._BaseNode.t_end = attr.ib(init=False, default=None, repr=False)

static

t_start

lib.nodes.interface._BaseNode.t_start = attr.ib(init=False, default=None, repr=False)

static

Property Documentation

end_node

lib.nodes.interface._BaseNode.end_node = property

static

full_state

lib.nodes.interface._BaseNode.full_state = property

static

Gets the node state.

in_error

lib.nodes.interface._BaseNode.in_error = property

static

Returns

bool Node in error state.

result

lib.nodes.interface._BaseNode.result = property

static

Node's result.

It has a different form depending on node type.

skip

lib.nodes.interface._BaseNode.skip = property

static

start_node

lib.nodes.interface._BaseNode.start_node = property

static

state

lib.nodes.interface._BaseNode.state = property

static

Gets the node state.

---

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

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