Alpha.Community

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

Буфер аргументов события

Вспомогательный тип. Представляет собой буфер, предназначенный для передачи аргументов события, реализованного с помощью компонента Команда (Action).

Запись и извлечение данных происходит по принципу FIFO1first-in-first-out – "первым пришел, первым ушел" (очереди). При переполнении буфера новые аргументы вытесняют старые также по принципу очереди.

Пример использования

Для демонстрации использования компонента разработан проект-пример. Проект-пример можно скачать и открыть в Дизайнер Alpha.HMI. Для работы с проектом-примером потребуются компоненты, указанные в Подготовка к работе, и Alpha.Server с подключенным модулем логики.

Предположим, необходимо получить данные о сигналах из Alpha.Server в проекте Alpha.HMI посредством JSON-запросов к API сервера. В результате получения необходимых данных должна выполняться определенная команда. Запрос по каждому сигналу происходит отдельно. Таких запросов может быть достаточно много. Поскольку запросы происходят асинхронно, к началу обработки результатов может быть получено несколько ответов. Чтобы не потерять результаты запросов, каждый из них помещается в буфер типа EventArgs, который по очереди передает полученные данные в команду в качестве аргумента.

Откройте форму MainForm в проекте-примере. На форме размещена кнопка Получить ID (ButtonGetIDs). Ознакомьтесь с кодом обработчика события ButtonPressed кнопки.

//по нажатию кнопки вызывается функция GetID типа ServerAPI
ServerAPI.GetID("Service.State.Pair");
ServerAPI.GetID("Service.State.Server");
ServerAPI.GetID("Service.Config.Version");

По нажатию кнопки вызывается функция GetID() компонента ServerAPI, разработанного для данного проекта-примера. В качестве входных параметров указаны имена сигналов Alpha.Server. Поскольку такие – сервисные – сигналы присутствуют в любой конфигурации, они выбраны для этого примера. Здесь можно указать любые имена сигналов, присутствующих в вашем сервере.

Обратите внимание на команду OnGetID здесь же, в компоненте ServerAPI. Это команда, выполняемая при получении ID сигнала из сервера. Она записывает полученное значение в текстовое поле TagsIDs. Именно в эту команду необходимо передавать аргумент - полученный ID сигнала.

Откройте тип ServerAPI. В типе созданы:

  • функция GetID(), отправляющая JSON-запрос на получение ID по имени сигнала на сервер;
  • элемент InvokeFromJSON, связанный с динамическим сигналом сервера InvokeFromJSON, куда функция GetID() отправляет JSON-запрос, а сервер помещает JSON-ответ;
  • pOnGetID – ссылка на команду OnGetID, реализованную в MainForm, выполняемую в результате получения ID сигнала;
  • буфер OnGetIDArgs, предназначенный для передачи полученного ID из ссылки на команду pOnGetID в команду OnGetID. Размер буфера ограничен десятью записями. Размер буфера можно изменить в свойстве BufferSize.

Ознакомьтесь с функцией GetID(). Функция использует API предоставления данных сервера. Подробнее API и работа с ним описаны в документе на модуль логики Alpha.Server.

transac += 1;
//наращиваем номер транзации (обращения к серверу)
request: string = "{\"transaction\":\""+String.ToString(transac)+"\",\"request\":{\"target\":\"Service.ServerApi\",\"method\":\"GetIdByTagName\",\"input\":{\"tagname\":\""+tagname+"\"}}}";
//в переменной request формируется запрос в формате JSON
InvokeFromJSON.TrySetValue(request);
//запрос помещается в компонент, связанный с динамическим сигналом сервера InvokeFromJSON
//сервер помещает ответ в формате JSON в этот же сигнал

В случае успешной записи ответа сервера в компонент InvokeFromJSON активируется событие OnValueChanged этого компонента. Ознакомьтесь с обработчиком этого события.

var ask = JSON.parse(value);
//при изменении значения сигнала - то есть, при получении ответа от сервера -
//полученное значение записывается в переменную ask, где его необходимо разобрать
var res = ask.result.return;
//в переменную res записывается значение ключа "return" - это и есть ID сигнала
OnGetIDArgs.Push(res);
//в буфер типа EventArgs записывается полученное значение - ID (иначе - аргумент)
pOnGetID.Invoke();
//вызывается команда, в которую передается полученный аргумент

Полученный от сервера JSON-ответ необходимо разобрать с помощью функции JSON.parse(), и затем выделенный из ответа ID поместить в буфер OnGetIDArgs с помощью функции Push(). После этого с помощью функции Invoke() по ссылке pOnGetID вызывается команда OnGetID, куда полученный ID передается через буфер.

Здесь разбирается внутренний аргумент события OnValueChanged компонента InvokeFromJSON – value, а не значение свойства Value этого компонента. Это тоже связано с асинхронностью процессов получения ответов от сервера.

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

Вернитесь на форму MainForm и ознакомьтесь с обработчиком события Invoked команды OnGetID.

var getresult = ServerAPI.OnGetIDArgs.Get();
//переменная getresult создается для извлечения аргумента события из буфера
TagsIDs.Text = TagsIDs.Text + " " + getresult;
//значение переменной записывается в текстовое поле

Здесь с помощью функции Get() происходит извлечение аргумента события из буфера OnGetIDArgs. Затем это значение используется для записи в текстовое поле на форме. Таким образом из буфера извлекается каждый полученный ID в момент получения ответа от сервера.