extgateway/ru.sydis.extgateway.api/DpModuleImpl

DpModuleImpl

class DpModuleImpl(api: BaseApi) : DpModule

Модуль для работы с точками данных (Data Points).

Предоставляет функциональность:

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

Constructors

DpModuleImpl

constructor(api: BaseApi)

Types

Connect

data class Connect<TDp, TVal>(val dps: TDp, val notifier: (dp: TDp, value: TVal) -> Unit)

Functions

connect

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

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

create

open override fun create(dpName: String, dpTypeName: String, token: String): Boolean

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

delete

open override fun delete(dpName: String, token: String): Boolean

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

disconnect

open override fun disconnect(connectID: String)

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

disconnectAll

open override fun disconnectAll()

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

exists

open override fun exists(dpName: String, token: String): Boolean

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

find

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

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

get

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

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

getPeriod

open override fun getPeriod(dps: List<String>, token: String, from: Long, to: Long, count: Int, nMax: Long): List<HistoryDataPoint>

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

info

open override fun info(dpName: String, token: String): String

names

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

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

rename

open override fun rename(dpName: String, newName: String, token: String): Boolean

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

set

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

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