extgateway/ru.sydis.extgateway.api/DpModule

DpModule

interface DpModule

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

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

Все методы могут выбрасывать исключения в случае ошибок взаимодействия с API. Вызывающий код должен корректно обрабатывать такие ситуации.

See also

dpConnectCallback

callback для получения уведомлений о новых значениях точки данных

Inheritors

Functions

abstract fun <TDp, TVal> connect(dp: TDp, token: String, callback: dpConnectCallback<TDp, TVal>): String

Подключается к точке данных и регистрирует коллбэк для получения значений.

abstract fun create(dpName: String, dpTypeName: String, token: String): Boolean

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

abstract fun delete(dpName: String, token: String): Boolean

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

abstract fun disconnect(connectID: String)

Отключает подписку по указанному идентификатору подключения.

abstract fun disconnectAll()

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

abstract fun exists(dpName: String, token: String): Boolean

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

abstract fun <T> find(pattern: String, typeName: String, ignoreCase: Boolean, systemID: T, token: String): List<String>

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

abstract fun <TDp, TVal> get(dp: TDp, token: String): TVal

Возвращает значение указанной точки данных.

abstract fun getPeriod(dps: List<String>, token: String, from: Long, to: Long, count: Int, nMax: Long = 0): List<HistoryDataPoint>

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

abstract fun info(dpName: String, token: String): String

abstract fun <T> names(pattern: String, typeName: String, ignoreCase: Boolean, systemID: T, token: String): List<String>

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

abstract fun rename(dpName: String, newName: String, token: String): Boolean

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

abstract fun <TDp, TVal> set(dp: TDp, value: TVal, token: String): Boolean

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