api/ru.sydis.api.dp/findDataPoints

findDataPoints

fun findDataPoints(pattern: String, systemId: Int = 1): MutableMap<Long, MutableList<Pair<Long, String>>>

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

Требуется, чтобы BaseApi был инициализирован перед вызовом.

Return

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

Parameters

pattern

шаблон.

systemId

ID системы(по умолчанию = 1, локальная система), из которой будет возвращаться список имен точек данных или имен элементов точек данных.

Throws

Если объект BaseApi не инициализирован.

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

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

Требуется, чтобы BaseApi был инициализирован перед вызовом.

Return

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

Parameters

pattern

шаблон. Не должно быть пустым.

typeName

имя типа точки данных по которому будет возвращаться список имен точек данных или имен элементов точек данных. Не должно быть пустым.

ignoreCase

булевый параметр, который определяет, должен ли поиск игнорировать регистр шаблона поиска (=true, по умолчанию) или нет (=false).

systemId

ID системы(по умолчанию = 1, локальная система), из которой будет возвращаться список имен точек данных или имен элементов точек данных.

Throws

Если typeName не найден

Если pattern и/или typeName пустой.

Если объект BaseApi не инициализирован.

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

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

Требуется, чтобы BaseApi был инициализирован перед вызовом.

Return

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

Parameters

pattern

шаблон. Не должно быть пустым.

typeId

ID типа точки данных по которому будет возвращаться список имен точек данных или имен элементов точек данных. Не должно быть пустым.

ignoreCase

булевый параметр, который определяет, должен ли поиск игнорировать регистр шаблона поиска (=true, по умолчанию) или нет (=false).

systemId

ID системы(по умолчанию = 1, локальная система), из которой будет возвращаться список имен точек данных или имен элементов точек данных.

Throws

Если pattern пустой и/или typeId равен нулю.

Если объект BaseApi не инициализирован.