lib.nodes.observing_block.ObservingBlock Class Reference

Inheritance diagram for lib.nodes.observing_block.ObservingBlock:

Public Member Functions
def	__attrs_post_init__ (self)
	Assigns node's name and id. More...
def	parameters (self)
	Returns a dictionary with template's parameters. More...
def	load (self)
	Loads json file. More...
def	module (self)
	Returns OB filename. More...
def	doc (self)
	Returns OB name from the corresponding kw. More...
def	clone (self, *args, **kw)
	Fake ctor for OB nodes. More...
Public Member Functions inherited from lib.nodes.sequence.Sequence
def	__iter__ (self)
def	context (self)
	Get context dictionary, preferably from root node. More...
def	context (self, ctx)
def	seq (self)
	Retrieves the sequence list. More...
def	seq (self, s)
	List used to create the Sequence's graph. More...
def	G (self)
	returns the graph object More...
def	start_step (self)
def	end_step (self)
def	start_node (self)
	Returns the start node. More...
def	end_node (self)
	Returns the end node. More...
def	append (self, s)
	Appends a node to the Sequence. More...
def	make_sequence (self, parent_tpl=None)
	Builds this sequence execution graph. 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)
def	execute (self, resume=False, propagate=False)
def	resume (self)
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	nodes (self)
	Return nodes from Graph. More...
def	get_node (self, node_id)
	Get node by id. 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 paramete. More...
def	state (self)
	Gets the node state. More...
def	state (self, value)
	Sets 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	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)

Static Public Member Functions
def	create (f, *args, **kw)
	Creates a :class:ObservingBlock node. More...
Static Public Member Functions inherited from lib.nodes.sequence.Sequence
def	get_context ()
def	create (*args, **kw)
	Sequence node constructor. More...

Public Attributes
	name
	seq
	serial_number
Public Attributes inherited from lib.nodes.sequence.Sequence
	serial_number
	name
	id
	state
	node state More...
	in_error
	runtime_flags
	t_start
	skip
	exception
	t_end

Static Public Attributes
	fname = attr.ib(default=None)
	content = attr.ib(default=attr.Factory(dict), repr=False, init=False)
dictionary	template_parameters = {}
	current_tpl_params = attr.ib(default=attr.Factory(dict), init=False)
	ctor = attr.ib(default=None, init=False)
	descr = attr.ib(default=attr.Factory(dict), init=False)
	from_otto = attr.ib(default=False, kw_only=True)
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
	serial_number = attr.ib(kw_only=True, init=False, default=0)
	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

Member Function Documentation

__attrs_post_init__()

def lib.nodes.observing_block.ObservingBlock.__attrs_post_init__

(

self

)

Assigns node's name and id.

Reimplemented from lib.nodes.sequence.Sequence.

clone()

def lib.nodes.observing_block.ObservingBlock.clone	(		self,
		*	args,
		**	kw
	)

Fake ctor for OB nodes.

create()

def lib.nodes.observing_block.ObservingBlock.create (   f, *  args, **  kw  )

static

Creates a :class:ObservingBlock node.

Parameters

f	JSON file with OB definition
id	Node id
name	node name

doc()

def lib.nodes.observing_block.ObservingBlock.doc

(

self

)

Returns OB name from the corresponding kw.

load()

def lib.nodes.observing_block.ObservingBlock.load

(

self

)

Loads json file.

module()

def lib.nodes.observing_block.ObservingBlock.module

(

self

)

Returns OB filename.

parameters()

def lib.nodes.observing_block.ObservingBlock.parameters

(

self

)

Returns a dictionary with template's parameters.

   The returned dictionary enumerates the OB's templates as keys and the values are
   Template's parameters

Reimplemented from lib.nodes.sequence.Sequence.

Member Data Documentation

content

lib.nodes.observing_block.ObservingBlock.content = attr.ib(default=attr.Factory(dict), repr=False, init=False)

static

ctor

lib.nodes.observing_block.ObservingBlock.ctor = attr.ib(default=None, init=False)

static

current_tpl_params

lib.nodes.observing_block.ObservingBlock.current_tpl_params = attr.ib(default=attr.Factory(dict), init=False)

static

descr

lib.nodes.observing_block.ObservingBlock.descr = attr.ib(default=attr.Factory(dict), init=False)

static

fname

lib.nodes.observing_block.ObservingBlock.fname = attr.ib(default=None)

static

from_otto

lib.nodes.observing_block.ObservingBlock.from_otto = attr.ib(default=False, kw_only=True)

static

name

lib.nodes.observing_block.ObservingBlock.name

seq

lib.nodes.observing_block.ObservingBlock.seq

serial_number

lib.nodes.observing_block.ObservingBlock.serial_number

template_parameters

dictionary lib.nodes.observing_block.ObservingBlock.template_parameters = {}

static

---

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

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