| | |
- ParamDictionary
class ParamDictionary |
| |
Almost every element in the puffin system can have zero or more <param>
elements. The ParamDictionary represents a dictionary of key names to parameter
value lists in the following format:
key:{paramValue1, paramValue2, paramValue3, ...]
|
| |
Methods defined here:
- __init__(self, paramNodeList)
- Constructor for ParamDictionary.
Keyword Arguments:
paramNodeList -- The list of <param> elements.
- dumpContents(self)
- Dump the contents of the ParamDictionary. Mostly used for debugging purposes.
- getParamList(self, paramKey)
- Return the complete value list for the specified parameter.
Keyword Arguments:
paramKey -- The key for the parameter value list you wish to retrieve.
- getParamValue(self, paramKey, index=0, default=None)
- Return either the first or specified value for this parameter. If no value
can be retrieved, return the default if one is specified.
Keyword Arguments:
paramKey -- The name of the parameter whose value you are attempting to retrieve.
index -- The index of the value in the parameter value list to return (default is 0).
default -- The default value to return should a 'real' value be unobtainable
(default is None).
Data and non-method functions defined here:
- __doc__ = 'Almost every element in the puffin system can h...aramValue1, paramValue2, paramValue3, ...]\n '
- __module__ = 'paramdictionary'
| |