seqlib.nodes.interface._BaseNode Class Reference

Base class for all sequence nodes. More...

Public Member Functions
def	result
	Node's result. More...
def	result
def	end_node
def	start_node
def	state
	Gets the node state. More...
def	state
	Sets the node state. More...
def	in_error
def	skip
def	skip
def	in_error
def	make_sequence
	does nothing More...
def	make_task
	Creates the task object that executes the node. More...
def	pause
def	resume
def	result
	Node's result. More...
def	result
def	end_node
def	start_node
def	state
	Gets the node state. More...
def	state
	Sets the node state. More...
def	in_error
def	skip
def	skip
def	in_error
def	make_sequence
	does nothing More...
def	make_task
	Creates the task object that executes the node. More...
def	pause
def	resume

Static Public Attributes
tuple	id = attr.ib(default=None, kw_only=True)
tuple	name = attr.ib(default=None, kw_only=True)
tuple	deps = attr.ib(default=attr.Factory(list), repr=False, kw_only=True, init=False)
tuple	exception = attr.ib(init=False, default=None, repr=False)
tuple	t_start = attr.ib(init=False, default=None, repr=False)
tuple	t_end = attr.ib(init=False, default=None, repr=False)
tuple	running_checkpoint

Detailed Description

Base class for all sequence nodes.

Parameters

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

Member Function Documentation

def seqlib.nodes.interface._BaseNode.end_node

(

self

)

def seqlib.nodes.interface._BaseNode.end_node

(

self

)

def seqlib.nodes.interface._BaseNode.in_error

(

self

)

Returns

bool Node in error state.

def seqlib.nodes.interface._BaseNode.in_error

(

self

)

Returns

bool Node in error state.

def seqlib.nodes.interface._BaseNode.in_error	(		self,
			flag = True
	)

def seqlib.nodes.interface._BaseNode.in_error	(		self,
			flag = True
	)

def seqlib.nodes.interface._BaseNode.make_sequence

(

self

)

does nothing

def seqlib.nodes.interface._BaseNode.make_sequence

(

self

)

does nothing

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

Creates the task object that executes the node.

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

Creates the task object that executes the node.

def seqlib.nodes.interface._BaseNode.pause

(

self

)

def seqlib.nodes.interface._BaseNode.pause

(

self

)

def seqlib.nodes.interface._BaseNode.result

(

self

)

Node's result.

It has a different form depending on node type.

def seqlib.nodes.interface._BaseNode.result

(

self

)

Node's result.

It has a different form depending on node type.

def seqlib.nodes.interface._BaseNode.result	(		self,
			v
	)

def seqlib.nodes.interface._BaseNode.result	(		self,
			v
	)

def seqlib.nodes.interface._BaseNode.resume

(

self

)

def seqlib.nodes.interface._BaseNode.resume

(

self

)

def seqlib.nodes.interface._BaseNode.skip

(

self

)

def seqlib.nodes.interface._BaseNode.skip

(

self

)

def seqlib.nodes.interface._BaseNode.skip	(		self,
			flag = True
	)

def seqlib.nodes.interface._BaseNode.skip	(		self,
			flag = True
	)

def seqlib.nodes.interface._BaseNode.start_node

(

self

)

def seqlib.nodes.interface._BaseNode.start_node

(

self

)

def seqlib.nodes.interface._BaseNode.state

(

self

)

Gets the node state.

def seqlib.nodes.interface._BaseNode.state

(

self

)

Gets the node state.

def seqlib.nodes.interface._BaseNode.state	(		self,
			value
	)

Sets the node state.

def seqlib.nodes.interface._BaseNode.state	(		self,
			value
	)

Sets the node state.

Member Data Documentation

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

static

tuple _BaseNode.exception = attr.ib(init=False, default=None, repr=False)

static

tuple _BaseNode.id = attr.ib(default=None, kw_only=True)

static

tuple _BaseNode.name = attr.ib(default=None, kw_only=True)

static

tuple _BaseNode.running_checkpoint

static

Initial value:

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

tuple _BaseNode.t_end = attr.ib(init=False, default=None, repr=False)

static

tuple _BaseNode.t_start = attr.ib(init=False, default=None, repr=False)

static

---

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

• INTROOT/lib/python3.7/site-packages/seqlib/nodes/interface.py
• seq/seqlib/src/seqlib/nodes/interface.py