spinetoolbox.project_items.exporter.widgets.parameter_merging_settings

Parameter merging settings widget.

author:

1. Soininen (VTT)

date:

19.2.2020

Module Contents

Classes

ParameterMergingSettings	A widget for configure parameter merging.
_DomainNameListModel	Model for domains_list_view.
_ParameterNameListModel	Model for parameter_name_list_view.

spinetoolbox.project_items.exporter.widgets.parameter_merging_settings._ERROR_MESSAGE = <span style='color:#ff3333;white-space: pre-wrap;'>{}</span>

class spinetoolbox.project_items.exporter.widgets.parameter_merging_settings.ParameterMergingSettings(entity_class_infos, parent, parameter_name=None, merging_setting=None)

Bases: PySide2.QtWidgets.QWidget

A widget for configure parameter merging.

Parameters:

• entity_class_infos (list) – list of EntityClassInfo objects
• parent (QWidget) – a parent widget
• parameter_name (str) – merged parameter name of None for widget
• merging_setting (MergingSetting) – merging settings or None for empty widget

removal_requested

Emitted when the settings widget wants to get removed from the parent window.

error_flags

parameter_name

Name of the merged parameter.

merging_setting(self)

Constructs the MergingSetting object from the widget’s contents.

update(self, entity_class_infos)

Updates the settings after database commit.

_check_state(self)

Updates the message label according to widget’s error state.

_clear_flag(self, state)

Clears a state flag.

_set_flag(self, state)

Sets a state flag.

_reset_indexing_domains_label(self, domain_name=None, domain_names=None)

Rewrites the contents of indexing_domains_label.

_update_parameter_name(self, name)

Updates the merged parameter name.

_remove_self(self, _)

Requests removal from the parent window.

_handle_domain_selection_change(self, selected, _)

Resets the settings after another item has been selected in domains_list_view.

_update_indexing_domain_name(self, name)

Resets indexing_domains_label.

_move_domain_left(self, _)

Moves the new indexing domain left in indexing_domains_label.

_move_domain_right(self, _)

Moves the new indexing domain left in indexing_domains_label.

class spinetoolbox.project_items.exporter.widgets.parameter_merging_settings._DomainNameListModel(entity_classes)

Bases: PySide2.QtCore.QAbstractListModel

Model for domains_list_view.

Stores EntityClassInfo objects displaying the entity name in domains_list_view.

Parameters:entity_classes (list) – a list of EntityClassObjects

data(self, index, role=Qt.DisplayRole)

Returns model’s data for given index.

headerData(self, section, orientation)

Returns None.

index_for(self, set_name)

Returns the QModelIndex for given set name.

item_at(self, row)

Returns the EntityClassInfo object at given row.

rowCount(self, parent=QModelIndex())

Returns the size of the model.

update(self, entity_classes)

Updates the model.

class spinetoolbox.project_items.exporter.widgets.parameter_merging_settings._ParameterNameListModel(names)

Bases: PySide2.QtCore.QAbstractListModel

Model for parameter_name_list_view.

Parameters:names (list) – list of parameter names to show in the view

data(self, index, role=Qt.DisplayRole)

Returns the model’s data.

flags(self, index)

Returns flags for given index.

headerData(self, section, orientation)

Returns None.

reset(self, names)

Resets the model’s contents when a new index is selected in domains_list_view.

rowCount(self, parent=QModelIndex())

Returns the number of parameter names.

select(self, names)

Selects parameters for inclusion in the merged parameter.

selected(self)

Returns a list of the selected parameters.

setData(self, index, value, role=Qt.EditRole)

Selects or deselects the parameter at given index for inclusion in the merged parameter.

update(self, names)

Updates the parameter names keeping the previous selection where it makes sense.