kappa_sdk.user_tasks.simulation.ParametersDictionarySimulation#

class kappa_sdk.user_tasks.simulation.ParametersDictionarySimulation(yaml_definition, parameter_group_type=ParametersGroupEnum.input)[source]#

Methods

ParametersDictionarySimulation.add_parameter(...)

Adds a new parameter to the dictionary.

ParametersDictionarySimulation.items()

Access to the class like a real dictionnary :returns: key, values of the class
Parameters:

  • yaml_definition (str)

  • parameter_group_type (ParametersGroupEnum)

__init__(yaml_definition, parameter_group_type=ParametersGroupEnum.input)[source]#
Parameters:

  • yaml_definition (str)

  • parameter_group_type (ParametersGroupEnum)

__getitem__(parameter_name)[source]#

Gets the value of the user task parameter identified by its name.

Parameters:

parameter_name (str) – The name of the user task parameter.

Return type:

bool | UUID | datetime | float | int | str | None

__setitem__(parameter_name, value)[source]#

Sets the value of the user task parameter identified by its name.

Parameters:

  • parameter_name (str) – The name of the user task parameter.

  • value (bool | UUID | datetime | float | int | str | None)

Return type:

None

items()[source]#

Access to the class like a real dictionnary :returns: key, values of the class

Return type:

ItemsView[str, Any]

add_parameter(parameter_name, data_type_name, value=None)[source]#

Adds a new parameter to the dictionary.

Parameters:

  • parameter_name (str) – The name of the parameter to add.

  • data_type_name (str) – The type of the parameter (e.g., ‘file’, ‘string’, ‘double’, etc.)

  • value (Optional) – The initial value for the parameter (default is None).

Raises:

ValueError – If the specified data_type_name is not supported.

Return type:

None