api/ru.sydis.api/BaseApi

BaseApi

open class BaseApi

Constructors

BaseApi

constructor()

Types

Companion

object Companion

ConnectData

data class ConnectData<Tdp, Tval>(val callback: (Tdp, Tval) -> Unit, val dps: Tdp, val typeDP: Class<Tdp>, val typeVal: Class<Tval>, var lastCallTime: Long = 0, var lastCallMsgValueHash: Int = 0)

Functions

callFunctionGlobal

fun callFunctionGlobal(param: ApiBaseObject.ConnectData)

dpConnect

fun dpConnect(callback: (dp: Array<String>, value: Array<Any>) -> Unit, dp: Array<String>): ByteString

fun dpConnect(callback: (dp: String, value: Any) -> Unit, dp: String): ByteString

fun dpConnect(callback: (ProtoDpId.Builder, Any) -> Unit, dp: ProtoDpId.Builder): ByteString

fun dpConnect(callback: (dp: String, value: Any) -> Unit, answer: Boolean, dp: String): ConnectSubsId

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

fun dpConnect(callback: (Array<ProtoDpId.Builder>, Any) -> Unit, dp: Array<ProtoDpId.Builder>): ByteString

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

fun dpConnect(callback: (dp: Array<String>, value: Array<Any>) -> Unit, answer: Boolean, dp: Array<String>): ConnectSubsId

fun dpConnect(callback: (dps: Array<ProtoDpId.Builder>, vals: Array<Any>) -> Unit, answer: Boolean, dp: Array<ProtoDpId.Builder>): ConnectSubsId

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

fun dpConnect(callback: (ProtoDpId.Builder, Any) -> Unit, answer: Boolean, dp: ProtoDpId.Builder): ConnectSubsId

Подписка на изменение точки данных по идентификатору.

dpDisconnect

fun dpDisconnect(subId: ConnectSubsId)

Отписка от одной подписки по идентификатору подписки

fun <Tdp, Tval> dpDisconnect(callback: (Tdp, Tval) -> Unit, dps: Tdp)

Отменяет подписку по callback и dps переданным при вызове dpConnect

dpDisconnectAll

fun dpDisconnectAll()

Отписка от всех текущих подписок.

dpQuery

fun dpQuery(query: String): DpQueryResult

Получает значения атрибутов в виде таблицы с помощью SQL-подобного запроса.

dpQueryCheck

fun dpQueryCheck(query: String): SqlQuery

Проверяет запрос на корректность. Возвращает структуру SqlQuery с результатами парсинга или бросает исключение в случае ошибки. Быстрый метод, всю работу делает локально, без использования брокера, обращения к другим сервисам и БД.

dpQueryCheckNoThrow

fun dpQueryCheckNoThrow(query: String): DpQueryCheckResult

Проверяет запрос на корректность. Метод не бросает исключений, поэтому хорошо подходит для проверки запросов по мере их ввода пользователем в поле ввода. Возвращает структуру DpQueryCheckResult с результатами парсинга - разобранным запросом или ошибкой. Быстрый метод, всю работу делает локально, без использования брокера, обращения к другим сервисам и БД.

dpQueryConnect

fun dpQueryConnect(query: String, callback: (data: DpQueryResult) -> Unit, answer: Boolean = true, onlyChanged: Boolean = false): ConnectSubsId

Включает подписку на изменение точек данных, попадающих под запрос. Результаты передаются в callback в виде объекта DpQueryResult.

dpQueryDisconnectAll

fun dpQueryDisconnectAll()

Отменяет все подписки, созданные через dpQueryConnect и dpQueryListConnect.

dpQueryList

@ApiStatus.Experimental

fun dpQueryList(query: String, sortOrder: ProtoDpQueryIdsSortOrder = ProtoDpQueryIdsSortOrder.BY_DP_NAME): List<ProtoValue.Builder>

Возвращает список точек данных, попадающих под запрос.

dpQueryListConnect

@ApiStatus.Experimental

fun dpQueryListConnect(query: String, sortOrder: ProtoDpQueryIdsSortOrder = ProtoDpQueryIdsSortOrder.BY_DP_NAME, callback: (List<ProtoValue>) -> Unit, answer: Boolean = true, onlyChanged: Boolean = false): ConnectSubsId

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