Alpha.Community

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

Функции

MoveNext

Перемещает указатель на следующее событие в очереди.

Синтаксис

bool MoveNext()

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

true Возвращается при успешном перемещении на следующий элемент очереди.
false Возвращается при отсутствии следующего элемента в очереди.

Примеры

Переместиться на следующее событие в очереди и при успешном перемещении вывести в журнал времени исполнения строку с данными текущего события.

moved: bool = ApAlarmQueue_1.MoveNext();
  DebugTool_1.Log(moved);
if (moved)
  DebugTool_1.Log(ApAlarmQueue_1.CurrentAlarm());

MoveFirst

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

Синтаксис

bool MoveFirst()

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

true Возвращается при успешном перемещении на первый элемент очереди.
false Возвращается при отсутствии элементов в очереди.

Примеры

Переместиться на первое событие в очереди и при успешном перемещении вывести в журнал времени исполнения строку с данными текущего события.

moved: bool = ApAlarmQueue_1.MoveFirst();
  DebugTool_1.Log(moved);
if (moved)
  DebugTool_1.Log(ApAlarmQueue_1.CurrentAlarm());

MoveNextOrFirst

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

Синтаксис

bool MoveNextOrFirst()

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

true Возвращается при успешном перемещении на следующий или первый элемент очереди.
false Возвращается при отсутствии следующего элемента в очереди или пустой очереди.

Примеры

Переместиться на следующее или первое событие в очереди и при успешном перемещении вывести в журнал времени исполнения строку с данными текущего события.

moved: bool = ApAlarmQueue_1.MoveNextOrFirst();
  DebugTool_1.Log(moved);
if (moved)
  DebugTool_1.Log(ApAlarmQueue_1.CurrentAlarm());

CurrentAlarm

Получает строку с данными текущего события (на котором сейчас находится указатель).

Синтаксис

string CurrentAlarm()

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

Возвращает строку, состоящую из значений атрибутов события:

source Источник события (тег сигнала).
condition Имя условия генерации события.
activeTime Время перехода состояния события в активное (в формате uint8).
sound Звуковой файл или группа звуковых файлов, воспроизводимых при выполнении подусловия генерации сообщения о событии.

Пример возвращаемой строки.

{"source":"Level.s_level", "condition:"LEVEL", "activeTime": 133032079365115751, "sound":";sound"}

Примеры

Вывести в журнал времени исполнения строку с данными текущего события.

DebugTool_1.Log("current: " + ApAlarmQueue_1.CurrentAlarm());

Reload

Запускает обновление списка активных событий с источника (объекта типа Запрос алармов).

Синтаксис

void Reload()

Примеры

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

ApAlarmQueue_1.JsonFilter = TextEdit_1.Text;
  ApAlarmQueue_1.Reload();

Clear

Очищает очередь.

Синтаксис

void Clear()

Примеры

Очистить очередь и вывести в журнал времени исполнения длину очереди.

len: var = ApAlarmQueue_1.Length;
ApAlarmQueue_1.Clear();
DebugTool_1.Log("clear: " + String.ToString(len));

RemoveCurrent

Удаляет текущее событие (на котором сейчас находится указатель). При удалении события указатель сбрасывается. Для удаления другого события принудительно переведите указатель на него с помощью функций MoveNext, MoveFirst или MoveNextOrFirst.

Синтаксис

void RemoveCurrent()

Примеры

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

len: var = ApAlarmQueue_1.Length;
ApAlarmQueue_1.RemoveCurrent();
DebugTool_1.Log "clear: " + String.ToString(len));

CancelRead

Прекращает получение данных с источника (объекта типа Запрос алармов), выполняемое функцией Reload.

Синтаксис

void CancelRead()

Примеры

Завершить получение данных.

ApAlarmQueue_1.CancelRead();