spinetoolbox.mvcmodels.tool_specification_model

Contains a class for storing Tool specifications.

authors:

16. Savolainen (VTT)

date:

23.1.2018

Module Contents

class spinetoolbox.mvcmodels.tool_specification_model.ToolSpecificationModel

Bases: PySide2.QtCore.QAbstractListModel

Class to store tools that are available in a project e.g. GAMS or Julia models.

rowCount(self, parent=None)

Must be reimplemented when subclassing. Returns the number of Tools in the model.

Parameters:parent (QModelIndex) – Not used (because this is a list) Returns:Number of rows (available tools) in the model

data(self, index, role=None)

Must be reimplemented when subclassing.

Parameters:

• index (QModelIndex) – Requested index
• role (int) – Data role

Returns:

Data according to requested role

flags(self, index)

Returns enabled flags for the given index.

Parameters:index (QModelIndex) – Index of Tool

insertRow(self, tool, row=None, parent=QModelIndex())

Insert row (tool specification) into model.

Parameters:

• tool (Tool) – Tool added to the model
• row (str) – Row to insert tool to
• parent (QModelIndex) – Parent of child (not used)

Returns:

Void

removeRow(self, row, parent=QModelIndex())

Remove row (tool specification) from model.

Parameters:

• row (int) – Row to remove the tool from
• parent (QModelIndex) – Parent of tool on row (not used)

Returns:

Boolean variable

update_tool_specification(self, row, tool)

Update tool specification.

Parameters:

• row (int) – Position of the tool to be updated
• tool (ToolSpecification) – new tool, to replace the old one

Returns:

Boolean value depending on the result of the operation

tool_specification(self, row)

Returns tool specification on given row.

Parameters:row (int) – Row of tool specification Returns:ToolSpecification from tool specification list or None if given row is zero

find_tool_specification(self, name)

Returns tool specification with the given name.

Parameters:name (str) – Name of tool specification to find

tool_specification_row(self, name)

Returns the row on which the given specification is located or -1 if it is not found.

tool_specification_index(self, name)

Returns the QModelIndex on which a tool specification with the given name is located or invalid index if it is not found.