Package schrodinger :: Package application :: Package jaguar :: Package gui :: Package tabs :: Module coordinates :: Class CoordinateTab

[frames] | no frames]

Class CoordinateTab

       object --+                    
                |                    
sip.simplewrapper --+                
                    |                
          sip.wrapper --+            
                        |            
     PyQt4.QtCore.QObject --+        
                            |        
           object --+       |        
                    |       |        
    sip.simplewrapper --+   |        
                        |   |        
 PyQt4.QtGui.QPaintDevice --+        
                            |        
          PyQt4.QtGui.QWidget --+    
                                |    
                 base_tab.BaseTab --+
                                    |
                                   CoordinateTab

Known Subclasses:

A parent class for the Scan and Optimization tabs

Nested Classes

[hide private]

Inherited from PyQt4.QtGui.QWidget: RenderFlag, RenderFlags

Inherited from PyQt4.QtGui.QPaintDevice: PaintDeviceMetric

Instance Methods

[hide private]

coordinateAdded(...)
A signal emitted when user adds new coordinate.

coordinateDeleted(...)
A signal emitted when user deletes a coordinate.

allCoordinatesDeleted(...)
A signal emitted when all coordinates are deleted.

coordinateSelected(...)
A signal emitted when user selects a coordinate in the table.

coordinateDeselected(...)
A signal emitted when user deselects a coordinate in the table.

refreshMarkers(...)
A signal emitted when the workspace markers should be refreshed, i.e., when we should make sure that only markers for the currently selected tab are displayed.

setup(self)
Perform tab specific initialization.

list

_getAtomsForRow(self, row_num)
Get the atom indices for the specified row

_highlightSelectedMarkers(self, current_sel, previous_sel)
Respond to a change in the selected table rows by changing the currently selected workspace marker

_checkSelection(self, sel, signal)
If the specified table selection is not empty, emit the given signal with the atom indices from the selected row.

NoneType or str

_determineIfConstraintsAddable(self)
Determine if the panel, workspace, and project are in a state where we can add constraints.

setAcceptableContraintEids(self, eids, picking_err)
Set the constraint picking restrictions

stopPicking(self)
Stop constraint picking

_resetDefaults(self)
This function resets coordinates table and sets coordinate picking to its default state.

_emitCoordinateAdded(self, atoms, coordinate_type)
If a marker doesn't yet exist for the specified atoms, emit the coordinateAdded signal to request that one be created.

_emitCoordinateDeleted(self, atoms)
After a constraint has been deleted for the specified atoms, delete the corresponding marker if there are no other constraints for that group of atoms.

Inherited from base_tab.BaseTab: __init__, activate, deactivate, error, getDefaultKeywords, getMmJagKeywords, loadPerAtomSettings, loadSettings, reset, saveSettings, validate, warning

Inherited from base_tab.BaseTab (private): _populateUi

Inherited from PyQt4.QtGui.QWidget: acceptDrops, accessibleDescription, accessibleName, actionEvent, actions, activateWindow, addAction, addActions, adjustSize, autoFillBackground, backgroundRole, baseSize, changeEvent, childAt, childrenRect, childrenRegion, clearFocus, clearMask, close, closeEvent, contentsMargins, contentsRect, contextMenuEvent, contextMenuPolicy, create, cursor, customContextMenuRequested, destroy, devType, dragEnterEvent, dragLeaveEvent, dragMoveEvent, dropEvent, effectiveWinId, enabledChange, ensurePolished, enterEvent, event, find, focusInEvent, focusNextChild, focusNextPrevChild, focusOutEvent, focusPolicy, focusPreviousChild, focusProxy, focusWidget, font, fontChange, fontInfo, fontMetrics, foregroundRole, frameGeometry, frameSize, geometry, getContentsMargins, grabGesture, grabKeyboard, grabMouse, grabShortcut, graphicsEffect, graphicsProxyWidget, handle, hasFocus, hasMouseTracking, height, heightForWidth, hide, hideEvent, inputContext, inputMethodEvent, inputMethodHints, inputMethodQuery, insertAction, insertActions, isActiveWindow, isAncestorOf, isEnabled, isEnabledTo, isEnabledToTLW, isFullScreen, isHidden, isLeftToRight, isMaximized, isMinimized, isModal, isRightToLeft, isTopLevel, isVisible, isVisibleTo, isWindow, isWindowModified, keyPressEvent, keyReleaseEvent, keyboardGrabber, languageChange, layout, layoutDirection, leaveEvent, locale, lower, mapFrom, mapFromGlobal, mapFromParent, mapTo, mapToGlobal, mapToParent, mask, maximumHeight, maximumSize, maximumWidth, metric, minimumHeight, minimumSize, minimumSizeHint, minimumWidth, mouseDoubleClickEvent, mouseGrabber, mouseMoveEvent, mousePressEvent, mouseReleaseEvent, move, moveEvent, nativeParentWidget, nextInFocusChain, normalGeometry, overrideWindowFlags, overrideWindowState, paintEngine, paintEvent, palette, paletteChange, parentWidget, pos, previousInFocusChain, raise_, rect, releaseKeyboard, releaseMouse, releaseShortcut, removeAction, render, repaint, resetInputContext, resize, resizeEvent, restoreGeometry, saveGeometry, scroll, setAcceptDrops, setAccessibleDescription, setAccessibleName, setAttribute, setAutoFillBackground, setBackgroundRole, setBaseSize, setContentsMargins, setContextMenuPolicy, setCursor, setDisabled, setEnabled, setFixedHeight, setFixedSize, setFixedWidth, setFocus, setFocusPolicy, setFocusProxy, setFont, setForegroundRole, setGeometry, setGraphicsEffect, setHidden, setInputContext, setInputMethodHints, setLayout, setLayoutDirection, setLocale, setMask, setMaximumHeight, setMaximumSize, setMaximumWidth, setMinimumHeight, setMinimumSize, setMinimumWidth, setMouseTracking, setPalette, setParent, setShortcutAutoRepeat, setShortcutEnabled, setShown, setSizeIncrement, setSizePolicy, setStatusTip, setStyle, setStyleSheet, setTabOrder, setToolTip, setUpdatesEnabled, setVisible, setWhatsThis, setWindowFilePath, setWindowFlags, setWindowIcon, setWindowIconText, setWindowModality, setWindowModified, setWindowOpacity, setWindowRole, setWindowState, setWindowTitle, show, showEvent, showFullScreen, showMaximized, showMinimized, showNormal, size, sizeHint, sizeIncrement, sizePolicy, stackUnder, statusTip, style, styleSheet, tabletEvent, testAttribute, toolTip, topLevelWidget, underMouse, ungrabGesture, unsetCursor, unsetLayoutDirection, unsetLocale, update, updateGeometry, updateMicroFocus, updatesEnabled, visibleRegion, whatsThis, wheelEvent, width, winId, window, windowActivationChange, windowFilePath, windowFlags, windowIcon, windowIconText, windowModality, windowOpacity, windowRole, windowState, windowTitle, windowType, x, x11Info, x11PictureHandle, y

Inherited from PyQt4.QtCore.QObject: __getattr__, blockSignals, childEvent, children, connect, connectNotify, customEvent, deleteLater, destroyed, disconnect, disconnectNotify, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, emit, eventFilter, findChild, findChildren, inherits, installEventFilter, isWidgetType, killTimer, metaObject, moveToThread, objectName, parent, property, pyqtConfigure, receivers, removeEventFilter, sender, senderSignalIndex, setObjectName, setProperty, signalsBlocked, startTimer, thread, timerEvent, tr, trUtf8

Inherited from PyQt4.QtGui.QPaintDevice: colorCount, depth, heightMM, logicalDpiX, logicalDpiY, numColors, paintingActive, physicalDpiX, physicalDpiY, widthMM

Inherited from sip.simplewrapper: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

Inherited from base_tab.BaseTab: HELP_TOPIC, NAME, UI_MODULES

Inherited from PyQt4.QtGui.QWidget: DrawChildren, DrawWindowBackground, IgnoreMask

Inherited from PyQt4.QtCore.QObject: staticMetaObject

Inherited from PyQt4.QtGui.QPaintDevice: PdmDepth, PdmDpiX, PdmDpiY, PdmHeight, PdmHeightMM, PdmNumColors, PdmPhysicalDpiX, PdmPhysicalDpiY, PdmWidth, PdmWidthMM

Instance Variables

[hide private]

Inherited from base_tab.BaseTab: input_selector, task_name, ui

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

coordinateAdded(...)

A signal emitted when user adds new coordinate. The signal is emitted with:

a list of atom numbers
coordinate type

coordinateDeleted(...)

A signal emitted when user deletes a coordinate. Emitted with a list of atom numbers.

allCoordinatesDeleted(...)

A signal emitted when all coordinates are deleted. Emitted with no arguments.

coordinateSelected(...)

A signal emitted when user selects a coordinate in the table. Emitted with a list of atom numbers for the selected coordinate.

coordinateDeselected(...)

A signal emitted when user deselects a coordinate in the table. Emitted with a list of atom numbers for the deselected coordinate.

setup(self)

Perform tab specific initialization. This function should be defined in subclasses if initialization is needed.

Overrides: base_tab.BaseTab.setup: (inherited documentation)

_getAtomsForRow(self, row_num)

Get the atom indices for the specified row

Parameters:

row_num (int) - A row number

Returns: list

A list of atom indices

_highlightSelectedMarkers(self, current_sel, previous_sel)

Respond to a change in the selected table rows by changing the currently selected workspace marker

Parameters:

current_sel (PyQt4.QtCore.QItemSelection) - The new table selection
previous_sel (PyQt4.QtCore.QItemSelection) - The previous table selection

_checkSelection(self, sel, signal)

If the specified table selection is not empty, emit the given signal with the atom indices from the selected row.

Parameters:

sel (PyQt4.QtCore.QItemSelection) - The table selection
signal (PyQt4.QtCore.pyqtSignal) - The singal to emit

_determineIfConstraintsAddable(self)

Determine if the panel, workspace, and project are in a state where we can add constraints.

Returns: NoneType or str: If we can add constraints, return None. Otherwise, return the text of the error message that should be displayed to the user.

setAcceptableContraintEids(self, eids, picking_err)

Set the constraint picking restrictions

Parameters:

eids (set) - The entry ids for which coordinate picking is acceptable.
picking_err (str or NoneType) - If picking should not be allowed at all, this is the text of the error that will displayed to the user. If picking is allowed, should be None.

_resetDefaults(self)

This function resets coordinates table and sets coordinate picking to its default state. Note that this function is not called reset() since it does not need to be called from the panel class.

_emitCoordinateAdded(self, atoms, coordinate_type)

If a marker doesn't yet exist for the specified atoms, emit the coordinateAdded signal to request that one be created. For single atom markers, We use _marker_count to keep track of the the number of constraints per marker. Note that We can only get multiple constraints per markers for single atom markers (i.e. if there's a Coordinate - X constraint and a Coordinate - Y constraint for the same atom)

Parameters:

atoms (list) - A list of atom indices for the atoms to mark
coordinate_type (int) - The coordinate type

_emitCoordinateDeleted(self, atoms)

After a constraint has been deleted for the specified atoms, delete the corresponding marker if there are no other constraints for that group of atoms.

Parameters:

atoms (list) - A list of atom indices for the deleted constraint