extgateway/ru.sydis.extgateway.api/DpTypeModule

DpTypeModule

interface DpTypeModule

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

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

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

See also

ProtoDpTypeStruct

структура, описывающая тип точки данных

Inheritors

Functions

Link copied to clipboard
abstract fun <T> create(systemID: T, typeName: String, struct: String, token: String): Boolean

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

Link copied to clipboard
abstract fun <T> delete(systemID: T, typeName: String, token: String): Boolean

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

Link copied to clipboard
abstract fun <T> get(systemID: T, dpTypeName: String, token: String): ProtoDpTypeStruct

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

Link copied to clipboard
abstract fun <T> getAll(systemID: T, token: String): List<ProtoDpTypeStruct>

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

Link copied to clipboard
abstract fun <T> isExists(systemID: T, typeName: String, token: String): Boolean

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

Link copied to clipboard
abstract fun <T> rename(systemID: T, typeName: String, newName: String, token: String): Boolean

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

Link copied to clipboard
abstract fun <T> update(systemID: T, typeName: String, struct: String, token: String): Boolean

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