titus.genpy.update

titus.genpy.update(state, scope, obj, path, to, arrayErrCode, mapErrCode, fcnName, pos)[source]

Return the updated state of a cell or pool at runtime (not in-place).

Parameters:
  • state (titus.genpy.ExecutionState) – runtime state object
  • scope (titus.util.DynamicScope) – dynamic scope object
  • obj (an object) – cell or pool data that should be replaced
  • path (list of integers and strings) – extraction path
  • to (an object, possibly callable) – replacement object; if callable, the function is called to perform the update
  • arrayErrCode (integer) – error code to raise if an array index is not found
  • mapErrCode (integer) – error code to raise if a map key is not found
  • fcnName (string) – function name for error reporting
  • pos (string or None) – position from locator marks for error reporting
Return type:

an object

Returns:

an updated version of the object, for the sake of replacement