Alpha.Community

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

Свойства

Отображаемое имя

Описание объекта (поля объекта). Позволяет указать произвольное (например, русскоязычное) имя для узнаваемости объекта (поля объекта) в проекте. Не мешает использованию базового англоязычного имени объекта (поля объекта) для обращения в коде.

Кардинальное число

Преобразует объект в массив и задает размер массива (количество элементов в массиве).

Значение

1 Одиночный объект.
>1 Массив соответствующей размерности.

Длина

int8 Length

Размер массива (количество элементов в массиве).

Есть только у массивов и доступно только для чтения в режиме рантайма.

Примеры

Записать в текстовое поле длину массива.

TextEdit_1.Text = Str.ToString (SW_1.Length);

Индекс

int8 Index

Индекс элемента в массиве. Позволяет отследить у какого элемента сработало то или иное событие.

Есть только у массивов и доступно только для чтения в режиме рантайма.

Примеры

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

TextEdit_2.Text = Str.ToString(Index);

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

TextEdit_3.Text = Str.ToString(penwidth[Index]);

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

if (SW_1.Mode.Index == 0)
ㅤTextEdit_1.Text = "Включен режим 1";
else
ㅤTextEdit_1.Text = "Включен режим 2";

Источник

Ссылка на компонент Источник AP, к дереву которого относится данный компонент Элемент AP.

Примеры

Записать в поле ввода сетевой адрес источника, к которому относится сигнал.

TextEdit.Text = ApItem.Source.Location;

Путь

string Path

Путь до сигнала относительно корня Источника.

Примеры

Записать путь к сигналу источника в поле ввода.

TextEdit.Text = ApItem.Path;

Значение

variant Value

Значение сигнала (сигнальное свойство 2 - Value). Тип значения зависит от типа компонента Элемент AP <type>. Если используется нетипизированный компонент Элемент AP, то для работы с данными применяется тип variant.

Примеры

Увеличить значение сигнала при выполнении условия.

if(SWStatus == 1)
  ApItem.Value += 1;

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

if(SWStatus == 0)
  TextEdit_1.Text = String.ToString(Variant.ToInt4(ApItem_1.Value, 0));

Значение в виде строки

string ValueAsString

Значение сигнала в строковом формате.

Доступно только для чтения в режиме рантайма.

Примеры

Записать значение сигнала источника AP в поле ввода.

var string = ApItem.ValueAsString;
Object.Text = string;

Качество

uint2 Quality

Качество сигнала (сигнальное свойство 3 - Quality).

Доступно только для чтения в режиме рантайма.

Значение

COMM_FAILURE (24) Отсутствие соединения с источником данных.
UNCERTAIN (64) Связь с источником данных установлена, но данные еще не получены.
BAD_CONFIG (4) Неверно заданные параметры сигнала.

Примеры

Записать качество сигнала источника AP в текстовое поле.

TextEdit_1.Text = String.ToString(ApItem_1.Quality);

Метка времени

Метка времени сигнала.

Доступно только для чтения в режиме рантайма.

Примеры

Записать метку времени сигнала источника AP в текстовое поле.

TextEdit_1.Text = String.ToString(ApItem_1.TimeStamp);

Полный тег

string Tag

Тег сигнала - полный путь к сигналу, начиная от корня дерева сигналов.

Доступно только для чтения в режиме рантайма.

Примеры

Записать полный путь к сигналу источника AP в поле редактирования.

TextEdit.Text = ApItem.Tag;

Флаг ведения истории

bool Historizing

Активирована ли функция записи истории для сигнала на сервере.

Доступно только для чтения в режиме рантайма.

Значение

true История сигнала записывается.
false История сигнала не записывается.

Канонический тип данных

uint1 CanonicalType

Тип сигнала на сервере.

Доступно только для чтения в режиме рантайма.

Оформлена ли подписка?

bool Advised

Текущее состояние подписки на сигнал.

Доступно только для чтения в режиме рантайма.

Значение

true Есть подписка на сигнал.
false Нет подписки на сигнал.

Примеры

Записать текущее состояние подписки на сигнал источника AP в поле ввода.

TextEdit_1.Text = String.ToString(ApItem_1.Advised);

Единицы измерения

string Units

Единицы измерения сигнала (сигнальное свойство 100 - EUnit).

Доступно только для чтения в режиме рантайма.

Примеры

Записать единицы измерения сигнала источника AP в текстовое поле.

TextField.Text = ApItem.Units;

Описание

string Description

Описание сигнала (сигнальное свойство 101 - Description).

Доступно только для чтения в режиме рантайма.

Примеры

Записать описание сигнала источника AP в текстовое поле.

TextField.Text = ApItem.Description;

Состояние подписки

uint1 AdviseState

Код состояния подписки на сигнал.

Доступно только для чтения в режиме рантайма.

Значение

0 Не подписано (not advised).
1 Выполняется процесс подписки (advising).
2 Подписано (advised).
3 Выполняется процесс отписки (unadvising).
4 Ошибка подписки (advice error).
5 Ошибка отписки (unadvice error).

Примеры

Записать код состояния подписки на сигнал источника AP в текстовое поле.

TextEdit_1.Text = String.ToString(ApItem_1.AdviseState);

Строковое описание состояния подписки

string AdviseStateString

Описание состояния подписки на сигнал в текстовом виде.

Доступно только для чтения в режиме рантайма.

Примеры

Записать текст описания состояния подписки на сигнал источника AP в текстовое поле.

TextField.Text = ApItem.AdviseStateString;

Состояние идентификации

uint1 IdentificationState

Текущее состояние идентификации компонента Элемент AP <type>. Используются для отслеживания состояния готовности компонента Элемент AP <type> к работе.

Доступно только для чтения в режиме рантайма.

Значение

0 Идентификация не выполнялась (NotIdentified).
1 Выполняется идентификация (Identifying).
2 Идентификация успешно завершена, компонент Элемент AP <type> готов к работе (Identified).
3 Идентификация завершилась ошибкой (IdentifyError).

Примеры

Записать код состояния идентификации компонента Элемент AP в текстовое поле.

TextEdit_1.Text = String.ToString(ApItem_1.IdentificationState);

Строковое описание состояния идентификации

string IdentificationStateAsString

Текстовое описание состояния идентификации компонента Элемент AP <type>. Используются для отслеживания состояния готовности компонента Элемент AP <type> к работе.

Доступно только для чтения в режиме рантайма.

Примеры

Записать текст описания состояния идентификации компонента Элемент AP в текстовое поле.

TextEdit_1.Text = ApItem_1.IdentificationStateAsString;

Пользовательское поле

uint8 CustomInfo

Свойство сигнала, созданное пользователем.

Доступно только для чтения в режиме рантайма.

Примеры

Записать значение пользовательского свойства сигнала в текстовое поле.

TextEdit_1.Text = String.ToString(ApItem_1.CustomInfo);

Флаг доступа к записи

bool IsWritable

Разрешена ли запись нового значения в сигнал через свойство Значение.

Доступно только для чтения в режиме рантайма.

Значение

true Запись в сигнал разрешена.
false Запись в сигнал запрещена.

Примеры

Изменить значение сигнала или отобразить сообщение о запрете записи.

if (ApItem.IsWritable)
ㅤㅤApItem.Value = 3.14;
else
ㅤ Text_1.Text = "Запись в сигнал запрещена.";

Флаг источника событий

bool IsEventSource

Является ли сигнал источником событий в Alpha.Server.

Доступно только для чтения в режиме рантайма.

Значение

true При изменении значения сигнала на сервере срабатывает условие генерации события.
false Для сигнала на сервере не создано условие генерации события.