spinetoolbox.project_items.combiner.combiner

Module for view class.

authors:

16. Savolainen (VTT), M. Marin (KHT), J. Olauson (KTH)

date:

14.07.2018

Module Contents

Classes

Combiner

Class for project items that are not category nor root.

class spinetoolbox.project_items.combiner.combiner.Combiner(toolbox, project, logger, name, description, x, y, cancel_on_error=False)

Bases: spinetoolbox.project_item.ProjectItem

Class for project items that are not category nor root. These items can be executed, refreshed, and so on.

x

horizontal position in the screen

Type:float

y

vertical position in the screen

Type:float

Combiner class.

Parameters:

• toolbox (ToolboxUI) – a toolbox instance
• project (SpineToolboxProject) – the project this item belongs to
• logger (LoggerInterface) – a logger instance
• name (str) – Object name
• description (str) – Object description
• x (float) – Initial X coordinate of item icon
• y (float) – Initial Y coordinate of item icon
• cancel_on_error (bool, optional) – if True, changes will be reverted on errors

static item_type()

See base class.

static item_category()

See base class.

execution_item(self)

Creates project item’s execution counterpart.

make_signal_handler_dict(self)

Returns a dictionary of all shared signals and their handlers. This is to enable simpler connecting and disconnecting.

_handle_cancel_on_error_changed(self, _state)

set_cancel_on_error(self, cancel_on_error)

restore_selections(self)

Restore selections into shared widgets when this project item is selected.

save_selections(self)

Save selections in shared widgets for this project item into instance variables.

open_db_editor(self, checked=False)

Opens selected db in the Spine database editor.

populate_reference_list(self)

Populates reference list.

update_name_label(self)

Update Combiner tab name label. Used only when renaming project items.

handle_execution_successful(self, execution_direction, engine_state)

Notifies Toolbox of successful database import.

_do_handle_dag_changed(self, resources)

Update the list of references that this item is viewing.

_update_references_list(self, resources_upstream)

Updates the references list with resources upstream.

Parameters:resources_upstream (list) – ProjectItemResource instances

_selected_indexes(self)

Returns selected indexes.

_db_url_codenames(self, indexes)

Returns a dict mapping url to provider’s name for given indexes in the reference model.

item_dict(self)

Returns a dictionary corresponding to this item.

notify_destination(self, source_item)

See base class.

static default_name_prefix()

see base class