List (hwx.inspire.core)¶
Store a list of values in a single attribute.
For example: integers = List(Int) features = List(Reference(Feature))
Public Methods¶
castForGet (self, obj, value)
castForSet (self, obj, value)
create (self, obj)
createList (self, listAttr, obj)
createListList (self, listAttr, obj)
disable (self, obj)
enable (self, obj)
getCreateArgs (self)
getDisplayName (self, obj)
getGuiValue (self, obj)
getInCoreValue (self, obj)
getUnits (self, obj)
getValue (self, obj)
getValueList (self, obj)
getValueListList (self, obj)
initialize (self, objCls, name)
loadValue (self, obj, value)
setInCoreValue (self, obj, value)
setValue (self, obj, value)
setValueList (self, obj, value)
setValueListList (self, obj, value)
Method Details¶
- classmethod apply(cls, **kwds)¶
Context manager to specify Attribute constructor kwds Useful to avoid repeating kwds while defining a related group
- castForGet(self, obj, value)¶
Converts and returns the attribute value to its external type.
- param obj
Object this attribute belongs to.
- type obj
GeneralObject
- param value
Value of the attribute to be converted.
- type value
Any
- returns
Converted value.
- rtype
value (Any)
- castForSet(self, obj, value)¶
Validates and returns the specifies value into a list.
- create(self, obj)¶
Creates the list attribute.
- createList(self, listAttr, obj)¶
Creates an attribute that has list of values for the specified object.
- createListList(self, listAttr, obj)¶
Creates an attribute that has nested list of values for the specified object.
- disable(self, obj)¶
Disables the list attribute.
- enable(self, obj)¶
Enables the list attribute.
- getCreateArgs(self)¶
Helper used in create methods
- getDisplayName(self, obj)¶
Returns the display name of the attribute.
Display name is used show the objects attribute name in the Property editor.
- getGuiValue(self, obj)¶
Returns the formatted list of values.
- getInCoreValue(self, obj)¶
Calls the incore get method (defined in C++) of the List attribute.
- getUnits(self, obj)¶
Returns the units of the attribute.
- getValue(self, obj)¶
Returns the list of value for the specified object.
- getValueList(self, obj)¶
Returns the list of values from the specified object.
- getValueListList(self, obj)¶
Returns the nested list of values from the specified object.
- initialize(self, objCls, name)¶
Initialize the list attribute.
- loadValue(self, obj, value)¶
Loads and sets the value, when a model is loaded.
- setInCoreValue(self, obj, value)¶
Calls the incore set method (defined in C++) for the List attribute.
- setValue(self, obj, value)¶
Sets the list of values for the specified object.
- setValueList(self, obj, value)¶
Sets the specified list of values for the attribute.
- setValueListList(self, obj, value)¶
Sets the specified nested list of values for the attribute.