extgateway/ru.sydis.extgateway.services/DpService

DpService

interface DpService : RpcService

Сервис для работы с точками данных (Data Points).

Предоставляет методы для создания, удаления, получения и изменения точек данных, а также подписки на изменения их значений. Каждый метод требует передачи идентификатора сессии, что позволяет системе определять контекст выполнения операций.

Inheritors

Properties

Link copied to clipboard
abstract val buildNotifyMessage: NotifyMessageBuilder

Функция для построения уведомлений о изменениях данных. Должна быть переопределена/установлена на этапе конфигурации или инициализации.

Functions

Link copied to clipboard
abstract fun dpConnect(sessionID: String, dpNames: Array<String>): Map<String, String>

Подписывается на изменения значений нескольких элементов точек данных.

abstract fun dpConnect(sessionID: String, dpName: String): Map<String, String>

Подписывается на изменения значения элемента точки данных.

Link copied to clipboard
abstract fun dpCreate(sessionID: String, dpName: String, dpTypeName: String): Boolean

Создаёт новую точку данных (Data Point) с указанным именем и типом.

Link copied to clipboard
abstract fun dpDelete(sessionID: String, dpName: String): Boolean

Удаляет точку данных по имени.

Link copied to clipboard
abstract fun dpDisconnect(sessionID: String, connectID: String): Boolean

Отключает подписку на изменения элементов точки данных.

Link copied to clipboard
abstract fun dpDisconnectAll(sessionID: String): Boolean

Отключает все активные подписки для указанной сессии.

Link copied to clipboard
abstract fun dpExists(sessionID: String, dpName: String): Boolean

Проверяет существование точки данных (Data Point) с указанным именем в рамках заданной сессии.

Link copied to clipboard
abstract fun dpFind(sessionID: String, pattern: String, typeName: String, ignoreCase: Boolean, systemID: Int): List<String>

Возвращает список имён точек данных, соответствующих заданному фильтру.

abstract fun dpFind(sessionID: String, pattern: String, typeName: String, ignoreCase: Boolean, systemName: String): List<String>

{@link #dpFind(String, String, String, Boolean, Int)} с именем системы вместо идентификатора.

Link copied to clipboard
abstract fun dpGet(sessionID: String, dpNames: Array<String>): Map<String, Any?>

Возвращает значения нескольких элементо точек данных.

abstract fun dpGet(sessionID: String, dpName: String): Any?

Возвращает значение элемента точки данных по имени.

Link copied to clipboard
abstract fun dpGetInfo(sessionID: String, dpName: String): String

Возвращает информацию о точке данных.

Link copied to clipboard
abstract fun dpGetPeriod(sessionID: String, dps: List<String>, from: Long, to: Long, count: Int, nMax: Long = 0): List<HistoryDataPoint>

Загружает исторические данные по списку имен точек данных за указанный период времени.

Link copied to clipboard
abstract fun dpNames(sessionID: String, pattern: String, typeName: String, ignoreCase: Boolean, systemID: Int): List<String>

Функция выполняет запрос к API для поиска точек данных, чьи имена и типы совпадают с указанными шаблонами. Результат включает полные имена в формате [<system>:]<data_point>.<element>:<config>.<detail>.<attr>

abstract fun dpNames(sessionID: String, pattern: String, typeName: String, ignoreCase: Boolean, systemName: String): List<String>

{@link #dpFind(String, String, String, Boolean, Int)} с именем системы вместо идентификатора.

Link copied to clipboard
abstract fun dpRename(sessionID: String, dpName: String, newName: String): Boolean

Переименовывает точку данных.

Link copied to clipboard
abstract fun dpSet(sessionID: String, dataMap: Map<String, Any>): Boolean

Устанавливает значения нескольких элементов точек данных.

abstract fun dpSet(sessionID: String, dpName: String, value: Any): Boolean

Устанавливает значение элемента точки данных.