matflow.WorkflowLoop#

class matflow.WorkflowLoop(index, workflow, template, num_added_iterations, iterable_parameters, parents)#

Bases: WorkflowLoop

Class to represent a Loop that is bound to a Workflow.

Methods

`add_iteration`
`get_child_loops`	Get loops whose task subset is a subset of this loop's task subset.
`get_parent_loops`	Get loops whose task subset is a superset of this loop's task subset.
`new_empty_loop`
`test_termination`	Check if a loop should terminate, given the specified completed element iteration.

Attributes

`app`
`downstream_tasks`	Return tasks that are not part of the loop, and downstream from this loop.
`index`
`iterable_parameters`
`name`
`num_added_iterations`
`num_iterations`
`parents`
`task_indices`	Get the list of task indices that define the extent of the loop.
`task_insert_IDs`
`task_objects`
`template`
`upstream_tasks`	Return tasks that are not part of the loop, and upstream from this loop.
`workflow`

Parameters:

index (int) –
workflow (app.Workflow) –
template (app.Loop) –
num_added_iterations (Dict[Tuple[int], int]) –
iterable_parameters (Dict[int:List[int, List[int]]]) –
parents (List[str]) –

add_iteration(parent_loop_indices=None, cache=None)#

Parameters:: cache (LoopCache | None) –

app = App(name='MatFlow', version='0.3.0a129')#

property downstream_tasks: List[WorkflowLoop]#: Return tasks that are not part of the loop, and downstream from this loop.

get_child_loops()#

Get loops whose task subset is a subset of this loop’s task subset. If two loops have identical task subsets, the first loop in the workflow loop list is considered the child.

Return type:: List[WorkflowLoop]

get_parent_loops()#

Get loops whose task subset is a superset of this loop’s task subset. If two loops have identical task subsets, the first loop in the workflow loop list is considered the child.

Return type:: List[WorkflowLoop]

property index#

property iterable_parameters#

property name#

classmethod new_empty_loop(index, workflow, template, iter_loop_idx)#

Parameters:

index (int) –
workflow (Workflow) –
template (Loop) –
iter_loop_idx (List[Dict]) –

Return type:

Tuple[WorkflowLoop, List[Dict[str, int]]]

property num_added_iterations#

property num_iterations#

property parents: List[str]#

property task_indices: Tuple[int]#: Get the list of task indices that define the extent of the loop.

property task_insert_IDs#

property task_objects#

property template#

test_termination(element_iter)#: Check if a loop should terminate, given the specified completed element iteration.

property upstream_tasks: List[WorkflowLoop]#: Return tasks that are not part of the loop, and upstream from this loop.

property workflow#