kappa_sdk.user_tasks.Services#

class kappa_sdk.user_tasks.Services(*args, **kwargs)[source]#

User task services.

Accessed as a built-in user task variable named services, this class provides access to a number of built-in user task services and object.

Note

Should not be instantiated directly.

Attributes

Services.context

Gets the context of this user task.

Services.data_command_service

Gets the data command service.

Services.data_enumerator

Gets the data enumerator service.

Services.data_query_service

Gets the data query service.

Services.event_publisher

Gets the event publisher associated with this user task.

Services.field

Gets the field this user task belongs to.

Services.log

Gets the logger for this user task.

Services.parameters

Gets the input and output parameters container.

Services.redefinition

Gets the redefine setting of this user task.

Services.rest_api

Gets the REST API instance.

Services.scheduler

Gets the scheduler service for this user task.

Services.unit_converter

Gets a configured unit converter.

Services.user_task

Gets the executing user task object.

Services.well

Gets the well this user task belongs to.

Methods

property rest_api: RestAPI#

Gets the REST API instance.

property unit_converter: UnitConverter#

Gets a configured unit converter.

property context: Context#

Gets the context of this user task.

property redefinition: Redefinition | None#

Gets the redefine setting of this user task.

property field: Field#

Gets the field this user task belongs to.

property well: Well#

Gets the well this user task belongs to.

property event_publisher: EventPublisher#

Gets the event publisher associated with this user task.

property data_enumerator: DataEnumerator#

Gets the data enumerator service.

property data_command_service: DataCommandService#

Gets the data command service.

property log: Log#

Gets the logger for this user task.

property scheduler: Scheduler#

Gets the scheduler service for this user task.

property parameters: Parameters#

Gets the input and output parameters container.

property data_query_service: DataQueryService#

Gets the data query service.

property user_task: UserTask#

Gets the executing user task object.

__init__(*args, **kwargs)#