kappa_sdk.user_tasks.simulation.UserTaskInstance#
- class kappa_sdk.user_tasks.simulation.UserTaskInstance(connection, context, redefinition=None, python_path=None)[source]#
Simulated user task instance.
Used to configure and run a user task in simulation mode.
Note
Should not be instantiated directly.
Attributes
UserTaskInstance.context
Gets the simulated user task context.
UserTaskInstance.field
Gets the field associated with the user task simulation.
UserTaskInstance.inputs
Gets an editable input parameters container of the simulated user task.
UserTaskInstance.outputs
Gets an editable output parameters container of the simulated user task.
UserTaskInstance.well
Gets the well associated with the user task simulation.
Methods
UserTaskInstance.bind_input
(input_name, ...)Automatically binds a user task input to data contained in an associated well using provided hints (data type, label).
UserTaskInstance.run
()Runs the user task in simulation mode.
- Parameters:
connection (Connection)
context (Context)
redefinition (Redefinition | None)
python_path (str | None)