Package schrodinger :: Package tasks :: Module parameters :: Class ParamModel
[hide private]
[frames] | no frames]

Class ParamModel

       object --+                    
                |                    
sip.simplewrapper --+                
                    |                
          sip.wrapper --+            
                        |            
     PyQt5.QtCore.QObject --+        
                            |        
                        Param --+    
                                |    
                    CompoundParam --+
                                    |
                                   ParamModel
Known Subclasses:

Inherit all functionality of CompoundParam with name that designates this class as a model. Models should themselves be parameters so that their corresponding view can be easily incorporated into a parent view. In this case, the model of the parent view will contain the model of the child view as a parameter.

WARNING: as descriptors, instances of this class will not behave normally if used as class variables.

Nested Classes [hide private]

Inherited from CompoundParam: __metaclass__

Inherited from Param: NO_VALUE

Instance Methods [hide private]
 
setParamMapper(self, param_mapper)
Sets the primary param mapper for this model.
 
updateModel(self)
Retrieves values from the mapped target object and updates this model accordingly.
 
updateTarget(self)
Updates the mapped target object with the current values of this model.

Inherited from CompoundParam: __eq__, __init__, __ne__, fromJson, isDefault, reset, setValue, toDict, toJson

Inherited from CompoundParam (private): _defaultValue

Inherited from Param: __get__, __repr__, __set__, ownerChain, valueChanged

Inherited from Param (private): _getValue, _propagateSignal, _setValue

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

Inherited from sip.simplewrapper: __new__

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

Class Variables [hide private]

Inherited from Param: DataClass, is_abstract

Inherited from PyQt5.QtCore.QObject: staticMetaObject

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

setParamMapper(self, param_mapper)

 

Sets the primary param mapper for this model. This allows the model itself to trigger the updating of values either to or from the mapped objects. Pass in None to clear the mapper.

Parameters:
  • param_mapper (mappers.AbstractParamMapper or None) - the primary param mapper for this model