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

Class ParamContainer

       object --+                
                |                
sip.simplewrapper --+            
                    |            
          sip.wrapper --+        
                        |        
     PyQt4.QtCore.QObject --+    
                            |    
            Qt.QtCore.QObject --+
                                |
                               ParamContainer
Known Subclasses:


This is a base class for regular objects (not desriptors) which will hold
params. Inheriting from this class is not required, as any object can hold
params and will work fine; however, doing so provides the following
benefits:

    * Convenience methods for converting to and from JSON and regular python
    dictionaries.

    * Dynamically generated signals for changes to individual param values.
    These signals are named <param name>Changed. For example, a
    ParamContainer with a param named "foo" will automatically have a signal
    called "fooChanged"

    * A general paramsChanged signal to indicate that any params have been
    changed, including nested subparams.

Nested Classes [hide private]
  __metaclass__
This metaclass modifies the creation of AbstractCompoundParam instances in the following ways:
Instance Methods [hide private]
 
paramsChanged(...)
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
 
resetParams(self)
 
paramsToDict(self)
 
paramsFromDict(self, param_dict)
 
paramsToJson(self)
 
paramsFromJson(self, json_str)
 
_propagateSignal(self)

Inherited from Qt.QtCore.QObject: connect, emit

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

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 PyQt4.QtCore.QObject: staticMetaObject

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)