Ufo.TaskNode

Subclasses:

Ufo.CopyTask, Ufo.DummyTask, Ufo.InputTask, Ufo.OutputTask

Methods

Inherited:

Ufo.Node (6), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

	add_in_group (pos, group)
	get_current_in_group (pos)
	get_identifier ()
	get_num_expected (pos)
	get_out_group ()
	get_package_name ()
	get_partition (index, total)
	get_plugin_name ()
	get_proc_node ()
	get_profiler ()
	get_send_pattern ()
	increase_processed ()
	reset ()
	set_identifier (name)
	set_num_expected (pos, n_expected)
	set_out_group (group)
	set_package_name (name)
	set_partition (index, total)
	set_plugin_name (name)
	set_proc_node (proc_node)
	set_profiler (profiler)
	set_send_pattern (pattern)
	setup ()
	switch_in_group (pos)

Virtual Methods

Inherited:

Ufo.Node (2), GObject.Object (7)

do_get_package_name ()

Properties

Name	Type	Flags	Short Description
num-processed	int	r	Number of processed elements

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent_instance	Ufo.Node	r

Class Details

class Ufo.TaskNode(**kwargs)

Bases:

Ufo.Node

Abstract:

No

Structure:

Ufo.TaskNodeClass

Main object for organizing filters. The contents of the Ufo.TaskNode structure are private and should only be accessed via the provided API.

add_in_group(pos, group)

Parameters:

• pos (int) –

• group (Ufo.Group) –

get_current_in_group(pos)

Parameters:

pos (int) – Input position of self

Returns:

The current in group of self for pos.

Return type:

Ufo.Group

Several nodes can be connected to input pos of self. However, at a time self will fetch only one buffer from all its inputs. This method returns the currently selected input group at pos.

get_identifier()

Return type:

str

get_num_expected(pos)

Parameters:

pos (int) –

Return type:

int

get_out_group()

Returns:

The out group of self.

Return type:

Ufo.Group

Get the current out of self. The out group is used to fetch the ouput buffer for self using Ufo.Group.pop_output_buffer().

get_package_name()

Return type:

str

get_partition(index, total)

Parameters:

• index (int) –

• total (int) –

get_plugin_name()

Return type:

str

get_proc_node()

Returns:

A Ufo.Node.

Return type:

Ufo.Node

Get the associated processing node of self.

get_profiler()

Returns:

A Ufo.Profiler object.

Return type:

Ufo.Profiler

Get the associated profiler of self.

get_send_pattern()

Return type:

Ufo.SendPattern

increase_processed()

reset()

Reset a task node so it can be re-used a second time.

set_identifier(name)

Parameters:

name (str) –

set_num_expected(pos, n_expected)

Parameters:

• pos (int) –

• n_expected (int) –

set_out_group(group)

Parameters:

group (Ufo.Group) –

set_package_name(name)

Parameters:

name (str) –

set_partition(index, total)

Parameters:

• index (int) –

• total (int) –

set_plugin_name(name)

Parameters:

name (str) –

set_proc_node(proc_node)

Parameters:

proc_node (Ufo.Node) –

set_profiler(profiler)

Parameters:

profiler (Ufo.Profiler) –

set_send_pattern(pattern)

Parameters:

pattern (Ufo.SendPattern) –

setup()

switch_in_group(pos)

Parameters:

pos (int) –

do_get_package_name() virtual

Return type:

str

Property Details

Ufo.TaskNode.props.num_processed

Name:

num-processed

Type:

int

Default Value:

0

Flags:

READABLE

Number of processed elements