Package-level declarations

Types

Link copied to clipboard
object CacheDpId

Functions

Link copied to clipboard
fun allAlertsForPeriod(periodFrom: Long, periodTo: Long): List<AlertHistoryData>

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

Link copied to clipboard
fun dpAddAttr(dp: String, attr: String): ProtoErrorCode

Добавления атрибута точки данных по имени

Link copied to clipboard

Получение ассоциативного массива аттрибутов точки данных по имени

Link copied to clipboard
fun dpCreate(dpName: String, typeId: Long): ProtoErrorCode
fun dpCreate(dpName: String, type: String): ProtoErrorCode

Создает новую точку данных.

Link copied to clipboard
fun dpDelete(dpId: Long): ProtoErrorCode

Удаляет существующую точку данных по ID.

fun dpDelete(dpName: String): ProtoErrorCode

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

Link copied to clipboard
fun dpDeleteAttr(dp: String, attr: String): ProtoErrorCode

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

Link copied to clipboard
fun dpExists(dpName: String): ProtoErrorCode

Проверяет заданную точку на существования.

Link copied to clipboard
fun dpGet(dp: Array<String>): List<Any>
fun dpGet(dp: Array<ProtoDpId.Builder>): List<Any>

Получение значений нескольких точек данных

fun dpGet(dp: String): Any

Получение значение точки данных по имени

fun dpGet(dp: ProtoDpId.Builder): Any

Получение значения точки данных по DpId

Link copied to clipboard

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

fun dpGetAlias(dpId: ProtoDpId.Builder): String

Получение псевдонима элемента точки данных по идентификатору

Link copied to clipboard
fun dpGetDescription(dp: String): ProtoLangString

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

fun dpGetDescription(dpId: ProtoDpId.Builder): ProtoLangString

Получение описания элемента точки данных по идентификатору

Link copied to clipboard
fun dpGetElements(typeId: Long, dpId: Long): List<ProtoBrowse.Builder>
Link copied to clipboard

Получение формата элемента точки данных по имени

fun dpGetFormat(dpId: ProtoDpId.Builder): String

Получение формата элемента точки данных по идентификатору

Link copied to clipboard
fun dpGetId(dp: String): ProtoDpId.Builder

Получение Id точки данных по имени

fun dpGetId(dps: List<String>): List<ProtoDpId.Builder>

Получение нескольких id точек данных одним запросом

Link copied to clipboard
fun dpGetIdByAlias(alias: String): ProtoDpId.Builder

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

fun dpGetIdByAlias(alias: List<String>): List<ProtoDpId.Builder>

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

Link copied to clipboard
fun dpGetInfo(dp: ProtoDpId.Builder): String
Link copied to clipboard
fun dpGetName(dps: List<ProtoDpId.Builder>): List<String>

Получение нескольких имён точек данных одним запросом

fun dpGetName(dp: ProtoDpId.Builder): String

Получение имени точки данных по DpId

Link copied to clipboard
fun dpGetType(systemId: Int, typeId: Long): ProtoDpTypeStruct.Builder
fun dpGetType(systemId: Int, name: String): ProtoDpTypeStruct.Builder
fun dpGetType(system: String, name: String): ProtoDpTypeStruct.Builder

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

Link copied to clipboard
fun dpGetTypes(systemId: Int): List<ProtoBrowse.Builder>
fun dpGetTypes(system: String): List<ProtoBrowse.Builder>

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

Link copied to clipboard

Получение единицы измерения элемента точки данных по имени

fun dpGetUnit(dpId: ProtoDpId.Builder): String

Получение единицы измерения элемента точки данных по идентификатору

Link copied to clipboard
fun dpNames(pattern: String, type: String, ignoreCase: Boolean = true, defaultSystem: Int = 1): List<String>

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

Link copied to clipboard
fun dpNamesWithIds(pattern: String, typeId: Long, ignoreCase: Boolean = true, systemId: Int = 1): List<Pair<String, Long>>

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

fun dpNamesWithIds(pattern: String, typeName: String, ignoreCase: Boolean = true, systemId: Int = 1): List<Pair<String, Long>>

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

Link copied to clipboard
@JvmName(name = "dpPeriodByNames")
fun dpPeriod(dpNames: List<String>, periodFrom: Long, periodTo: Long, count: Int, nMax: Long = 0): List<DpHistoryData>

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

@JvmName(name = "dpPeriodByIds")
fun dpPeriod(dps: List<ProtoDpId>, periodFrom: Long, periodTo: Long, count: Int, nMax: Long = 0): List<DpHistoryData>

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

Link copied to clipboard
fun dpRename(dpId: Long, newName: String): ProtoErrorCode

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

fun dpRename(dpName: String, newName: String): ProtoErrorCode

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

Link copied to clipboard
fun dpSet(vararg pairs: Pair<Any, Any>): ProtoErrorCode

Установка значений точек данных по парам (имя/ID и значение).

fun dpSet(dps: Array<String>, values: Array<Any>): ProtoErrorCode
fun dpSet(dps: Array<ProtoDpId.Builder>, values: Array<Any>): ProtoErrorCode

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

fun dpSet(dp: String, value: Any): ProtoErrorCode

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

fun dpSet(dp: ProtoDpId.Builder, value: Any): ProtoErrorCode

Запись значения в точку данных по Id

Link copied to clipboard
fun dpSetAlias(dp: String, alias: String): ProtoErrorCode

Запись псевдонима элемента точки данных

fun dpSetAlias(dpId: ProtoDpId.Builder, alias: String): ProtoErrorCode

Запись описания элемента точки данных

Link copied to clipboard
fun dpSetByAlias(vararg pairs: Pair<Any, Any>): ProtoErrorCode

Установка значений точек данных по парам (имя/ID и значение).

fun dpSetByAlias(dps: Array<String>, values: Array<Any>): ProtoErrorCode

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

fun dpSetByAlias(dp: String, value: Any): ProtoErrorCode

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

Link copied to clipboard
fun dpSetDescription(dpId: ProtoDpId.Builder, description: ProtoLangString): ProtoErrorCode
fun dpSetDescription(dp: String, description: String, langId: ProtoLanguageId = ProtoLanguageId.RU_RU): ProtoErrorCode

Запись описания элемента точки данных

Link copied to clipboard
fun dpSetFormat(dp: String, format: String): ProtoErrorCode

Запись формата элемента точки данных по имени

fun dpSetFormat(dpId: ProtoDpId.Builder, format: String): ProtoErrorCode

Запись формата элемента точки данных по идентификатору

Link copied to clipboard
fun dpSetUnit(dp: String, unit: String): ProtoErrorCode
fun dpSetUnit(dpId: ProtoDpId.Builder, unit: String): ProtoErrorCode

Запись единицы измерения элемента точки данных

Link copied to clipboard
fun dpTypeCreate(systemId: Int, name: String, struct: String, parent: Long = 0): ProtoErrorCode
fun dpTypeCreate(system: String, name: String, struct: String, parent: Long = 0): ProtoErrorCode

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

Link copied to clipboard
fun dpTypeDelete(systemId: Int, typeId: Long): ProtoErrorCode
fun dpTypeDelete(systemId: Int, name: String): ProtoErrorCode
fun dpTypeDelete(system: String, name: String): ProtoErrorCode

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

Link copied to clipboard
fun dpTypeExists(nameType: String, systemId: Int = 1): ProtoErrorCode

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

Link copied to clipboard
fun dpTypeRename(systemId: Int, typeId: Long, oldName: String, newName: String): ProtoErrorCode
fun dpTypeRename(system: String, typeId: Long, oldName: String, newName: String)

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

Link copied to clipboard
fun dpTypeUpdate(systemId: Int, name: String, struct: String): ProtoErrorCode
fun dpTypeUpdate(systemId: Int, typeId: Long, name: String, struct: String): ProtoErrorCode
fun dpTypeUpdate(system: String, typeId: Long, name: String, struct: String)

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

fun dpTypeUpdate(system: String, name: String, struct: String)
Link copied to clipboard
fun findDataPoints(pattern: String, systemId: Int = 1): MutableMap<Long, MutableList<Pair<Long, String>>>

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

fun findDataPoints(pattern: String, typeId: Long, ignoreCase: Boolean = true, systemId: Int = 1): List<String>

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

fun findDataPoints(pattern: String, typeName: String, ignoreCase: Boolean = true, systemId: Int = 1): List<String>

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

Link copied to clipboard
fun genKey(): ByteString
Link copied to clipboard
fun genMessage(cmd: ProtoCmdType, manId: ProtoManId = sr.manId): ProtoMessageWrapper
Link copied to clipboard
fun getSystemId(system: String): Int

Получение ID системы по имени

Link copied to clipboard

Получение списка всех систем и их идентификаторов

Link copied to clipboard
fun moduleInit(): List<ProtoValue.Builder>

Инициализация модуля и получение всех системных сообщений для определенных менеджеров

Link copied to clipboard
fun periodValuesCount(dpNames: List<String>, periodFrom: Long, periodTo: Long, count: Int): Int

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