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)

__init__(connection, context, redefinition=None, python_path=None)[source]#

Parameters:

connection (Connection)
context (Context)
redefinition (Redefinition | None)
python_path (str | None)

bind_input(input_name, data_type, label=None)[source]#

Automatically binds a user task input to data contained in an associated well using provided hints (data type, label). Raises an exception if data cannot be matched and bound to the input.

Parameters:

data_type (str | None) – A data-type to search for. If match by data-type is not found, it will try to match by label with the same value.
label (str | None) – A label to search for.
input_name (str)

Return type:

None

property field: Field#: Gets the field associated with the user task simulation.

property well: Well#: Gets the well associated with the user task simulation.

property context: Context#: Gets the simulated user task context.

property inputs: ParametersDictionarySimulation#: Gets an editable input parameters container of the simulated user task.

property outputs: ParametersDictionarySimulation#: Gets an editable output parameters container of the simulated user task.