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

Class EnumParam

       object --+                
                |                
sip.simplewrapper --+            
                    |            
          sip.wrapper --+        
                        |        
     PyQt5.QtCore.QObject --+    
                            |    
                        Param --+
                                |
                               EnumParam

Nested Classes [hide private]

Inherited from Param: NO_VALUE

Instance Methods [hide private]
 
__init__(self, enum_class, default_value, *args, **kwargs)
EnumParam must be initialized with the Enum class that this param is to be based on as well as the default value.
 
_setValue(self, owner_instance, value)
Sets a new value for this param for the specified instance.

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

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

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]

__init__(self, enum_class, default_value, *args, **kwargs)
(Constructor)

 

EnumParam must be initialized with the Enum class that this param is to be based on as well as the default value.

Parameters:
  • enum_class (enum.Enum) - the enum class to base this pram on
  • default_value (a member of the enum_class) - the default enum value
Overrides: object.__init__

_setValue(self, owner_instance, value)

 

Sets a new value for this param for the specified instance.

Parameters:
  • owner_instance - the instance on which this param is an attribute
  • value - the new value to set for this param
Overrides: Param._setValue
(inherited documentation)