Package schrodinger :: Package application :: Package jaguar :: Package gui :: Package tabs :: Module scan_tab :: Class ScanCoordinatesModel

[frames] | no frames]

Class ScanCoordinatesModel

PyQt4.QtCore.QAbstractTableModel --+    
                                   |    
        coordinates.CoordinatesModel --+
                                       |
                                      ScanCoordinatesModel

A model to store scan tab coordinates data.

Instance Methods

bool

addCoordinate(self, st, atoms, coordinate_type, start_value=None, final_value=None, increment=None)
Add new coordinate row.

data(self, index, role=Qt.DisplayRole)
Retrieve the requested data

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

Inherited from coordinates.CoordinatesModel: __init__, checkNewCoordinate, columnCount, findCoordinate, headerData, removeCoordinate, removeRow, reset, rowCount

Class Variables

object COLUMN = ScanCoordinateColumns()
class that contains information about columns in which coordinates data is displayed.

Method Details

addCoordinate(self, st, atoms, coordinate_type, start_value=None, final_value=None, increment=None)

Add new coordinate row.

Parameters:

st (schrodinger.structure.Structure) - structure
atoms (list) - atom indices
coordinate_type (int) - coordinate type
start_value (float) - starting coordinate value
final_value (float) - final coordinate value
increment (float) - increment value

Returns: bool

returns True if this is a new coordinate and False otherwise.

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

Retrieve the requested data

Parameters:

index (PyQt4.QtCore.QModelIndex) - The index to retrieve data for
role (int) - The role to retrieve data for

Returns:

The requested data

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

Modify coordinate values.

Parameters:

index (QtCore.QModelIndex) - the index of table cell
value - new value
role (int) - The role to set data for.