Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Функции

GetChildren

Функция устарела.

При вызове этой функции компонент Браузер источника АР выполняет браузинг узлов дерева сигналов источника данных, начиная с указанного родительского узла. Если параметр parentNode не задан (равен пустой строке), то браузинг начинается с корня дерева.

Синтаксис

void GetChildren(string parentNode)

Параметры

parentNode Строка, представляющая путь к родительскому узлу.

Примеры

Выполнить браузинг узлов дерева сигналов, начиная с корня.

ApSourceBrowser_1.GetChildren(" ");

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

ApSourceBrowser_1.GetChildren("папка1.общие параметры.сигналы");

GetSourceNodes

Функция устарела.

Получает информацию о поддереве узла источника данных, основываясь на заданном фильтре.

Параметр filter представляет собой строку с выражением в формате wildcard filter, где символы * и ? используются для фильтрации узлов.

Синтаксис

void GetSourceNodes(string filter)

Параметры

filter

Строка, содержащая выражение в формате wildcard filter для фильтрации узлов.
Пример фильтрации:

  • server_* - этот фильтр выберет все узлы, начинающиеся с server_, например, server_1, server_data, server_backup, и т. д.
  • param? - этот фильтр выберет все узлы, где после слова param идет ровно один любой символ, например, param1, param2, paramA, но не param, так как в этом случае после param нет символа.

Примеры

Отфильтровать узлы источника данных по имени, оставляя только те, которые начинаются с sensor.

// Фильтр для поиска узлов, начинающихся с "sensor"
filter: string = "sensor*";
// Вызов функции GetSourceNodes() с передачей фильтра
ApSourceBrowser_1.GetSourceNodes(filter);

GetChildrenWithRequestId

При вызове этой функции компонент Браузер источника АР создает запрос к источнику данных для получения узлов дерева сигналов по указанному родительскому узлу.

Результаты запроса (дочерние узлы) автоматически прикрепляются к узлу с идентификатором запроса requestId в графическом компоненте Дерево(или другой структуре данных), который был предварительно создан с использованием метода AddItem().

Синтаксис

void GetChildrenWithRequestId(string parentNode, string requestId)

Параметры

parentNode Строка, представляющая родительский узел, для которого будет выполнен брауз.
requestId Идентификатор запроса, который соответствует родительскому узлу, к которому должен быть прикреплен результат брауза.

Примеры

Создать корневой элемент Модули в компоненте Дерево и загрузить дочерние элементы для узла Модули.

x: string = Tree_1.AddItem("", "Модули");

Вызываем метод GetChildrenWithRequestId() для загрузки дочерних элементов для узла Модули с использованием идентификатора x:

ApSourceBrowser_1.GetChildrenWithRequestId("Модули", x);

Browse

Используется для получения списка узлов источника данных с возможностью выбора необходимых столбцов и применения фильтров. Метод позволяет запрашивать дочерние узлы или все узлы на определенном уровне дерева.

Синтаксис

uint4 Browse(string parameters)

Параметры

parameters string JSON-строка, содержащая параметры запроса, такие как уровень, корневой узел, фильтры и необходимые столбцы для отображения

Параметры JSON

Ключ Описание Тип данных Возможные значения Обязательный Особенности
level Уровень выполнения запроса. string children, descendants Нет

По умолчанию children.

children - только дочерние узлы, descendants - все потомки узла.

rootPath Полный путь к корневому узлу для выполнения запроса. string - Нет Если пустая строка, запрос выполняется относительно корня.
filter Условие фильтрации результатов. object - Нет Поддерживается wildcard-фильтр (например: "name": "Sensor*").
columns Список колонок для вывода данных. array Массив объектов с описанием Да Определяет структуру выходных данных.

Описание колонок (columns)

Ключ Описание Тип данных Возможные значения Обязательный Особенности
id Идентификатор колонки. string - Да -
type Тип данных колонки. string attribute, property, runtime, custom Да -
parameters Параметры колонки. object См. ниже параметры для каждого типа Да Зависят от типа колонки.

Параметры для типа attribute

Ключ Описание Тип данных Возможные значения Обязательный Особенности
id Идентификатор атрибута узла. string См. таблицу атрибутов ниже. Да Определяет, какой атрибут узла будет возвращен.

Таблица атрибутов узла

Идентификатор Описание Тип данных Возможные значения
cdt Канонический тип данных. uint4 —
id Конфигурационный идентификатор узла в источнике. uint8 —
runtimeId Временный идентификатор узла в источнике (уникален в рамках источника, изменяется при перезагрузке сервера). uint4 —
parentRuntimeId Временный идентификатор родительского узла в источнике (уникален в рамках источника, изменяется при перезагрузке сервера). uint4 —
displayName Имя узла (Description или Name, если нет Description). string —
name Короткое имя узла. string —
description Описание узла. string —
tag Полный тег узла. string —
units Единицы измерения. string —
hasChildren Наличие дочерних узлов. bool
  • false — узел не имеет дочерних узлов;
  • true — узел имеет дочерние узлы.
isWritable Доступ на запись в узел. bool
  • false — значение не может быть записано;
  • true — значение может быть записано.
isEventSource Является ли узел источником событий. bool
  • false — информация не получена от сервера;
  • true — узел является источником событий
isHistorized Ведётся ли запись истории. bool
  • false — запись истории не ведётся;
  • true — запись истории ведётся.

Параметры для типа property

Ключ Описание Тип данных Возможные значения Обязательный Особенности
number Номер пользовательского свойства. int - Да Определяет номер свойства узла для получения значения.

Параметры для типа runtime

Колонки с типом runtime используются для запроса текущих значений сигналов (Value, Quality, Timestamp и т. д.).

Колонки с типом runtime возвращают значения сигналов (Value, Quality, Timestamp и др.) только на момент выполнения запроса. Эти данные не обновляются автоматически в реальном времени. Чтобы получить новые значения, необходимо повторно вызвать метод Browse().

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

Ключ Описание Тип данных Возможные значения Обязательный Особенности
id Идентификатор данных string См. таблицу ниже Да Используется для получения значений определённых на момент запроса.

Возможные идентификаторы

Идентификатор Описание Тип данных
value Значение сигнала (сигнальное свойство 2 — Value) variant
quality Качество сигнала (сигнальное свойство 3 — Quality) uint2
timestamp Метка времени uint8
custom_info Пользовательское поле uint8

Параметры для типа custom

Ключ Описание Тип данных Возможные значения Обязательный Особенности
type Тип данных для пользовательского столбца. string bool, int1, int2, int4, int8, uint1, uint2, uint4, uint8, float, double, string, timestamp, variant, void Да -

Возвращаемое значение

Возвращает уникальный идентификатор запроса (uint4), который можно использовать для отслеживания выполнения запроса.

Примеры

Запросить дочерние узлы с колонками name и id с использованием языка JavaScript:

// Создаем объект запроса
var requestParams = {
  "level": "children",
  "rootPath": "RootNode",
  "columns": [
    {
      "id": "nodeName",
      "type": "attribute",
      "parameters": {
        "id": "name"
      }
    },
    {
      "id": "nodeId",
      "type": "attribute",
      "parameters": {
        "id": "id"
      }
    }
  ]
};

// Преобразуем объект в строку JSON
var requestString = JSON.stringify(requestParams);

// Вызываем метод Browse с параметром
Tree_1.TreeDataSource_1.ApSourceBrowser_1.Browse(requestString);

Запросить все узлы начинающиеся с sensor с использованием языка JavaScript:

// Создаем объект запроса
var requestParams = {
    "level": "descendants",
    "filter": {
        "name": "sensor*"
    },
    "columns": [
        {
            "id": "nodeName",
            "type": "attribute",
            "parameters": {
                "id": "name"
            }
        }
    ]
};

// Преобразуем объект в строку JSON
var requestString = JSON.stringify(requestParams);

// Вызываем метод Browse с параметром
Tree_1.TreeDataSource_1.ApSourceBrowser_1.Browse(requestString);

Запросить список всех узлов, имена которых начинаются с LU1*, и дополнительно получить для них текущее значение сигнала (value) и его метку времени (timestamp) с использованием языка JavaScript.

// Формируем параметры запроса
var requestParams = {
    "level": "descendants",
    "filter": {
        "name": "LU1*"
    },
    "columns": [
        {
            "id": "nodeName",
            "type": "attribute",
            "parameters": {
                "id": "name"
            }
        },
        {
            "id": "nodeId",
            "type": "attribute",
            "parameters": {
                "id": "id"
            }
        },
        {
            "id": "signalValue",
            "type": "runtime",
            "parameters": {
                "id": "value"
            }
        },
        {
            "id": "signalTimestamp",
            "type": "runtime",
            "parameters": {
                "id": "timestamp"
            }
        }
    ]
};

// Преобразуем объект в JSON-строку
var requestString = JSON.stringify(requestParams);

// Выполняем запрос методом Browse
Tree_1.TreeDataSource_1.ApSourceBrowser_1.Browse(requestString);