Alpha.Community

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

Функции

Convert

variant Convert(variant value, string dataType)

Конвертирует значение value типа variant в значение типа dataType. Результат функции хранится в переменной типа variant.

В качестве значения dataType можно указывать только названия типов данных языка Alpha.Om. Типы можно найти в документе на соответствующий продукт, либо в таблице, приведенной в описании функции CanonicalTypeToDataType (см. столбец Название типа). Также можно использовать значение, возвращаемое этой функцией.

Входные параметры:

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

Преобразование выполняется с учетом ограничений пространства имен TypeConvert. Подробнее об ограничениях – в документе на Alpha.Om.

number: variant = Converter.Convert(52, "uint4")

StringToVariant

variant StringToVariant(string value, string dataType)

Конвертирует строковое значение value в значение типа dataType. Результат функции хранится в переменной типа variant.

В качестве значения dataType можно указывать только названия типов данных языка Alpha.Om. Типы можно найти в документе на соответствующий продукт, либо в таблице, приведенной в описании функции CanonicalTypeToDataType (см. столбец Название типа). Также можно использовать значение, возвращаемое этой функцией.

Входные параметры:

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

number: variant = Converter.StringToVariant("52", "uint4")

VariantToString

string VariantToString(variant value, string dataType)

Конвертирует переменную типа variant, хранящую значение value типа dataType, в значение типа string.

В качестве значения dataType можно указывать только названия типов данных языка Alpha.Om. Типы можно найти в документе на соответствующий продукт, либо в таблице, приведенной в описании функции CanonicalTypeToDataType (см. столбец Название типа). Также можно использовать значение, возвращаемое этой функцией.

Входные параметры:

  • конвертируемое значение;
  • тип данных конвертируемого значения.

Number.Text = Converter.VariantToString(52, "uint4")

VariantToLocalizedString

string VariantToLocalizedString(variant value, string dataType)

Конвертирует переменную типа variant, хранящую значение value типа dataType, в значение типа string с учетом региональных настроек. В региональных настройках могут быть заданы точность (количество знаков после разделителя) и знак разделителя.

В качестве значения dataType можно указывать только названия типов данных языка Alpha.Om. Типы можно найти в документе на соответствующий продукт, либо в таблице, приведенной в описании функции CanonicalTypeToDataType (см. столбец Название типа). Также можно использовать значение, возвращаемое этой функцией.

Входные параметры:

  • конвертируемое значение;
  • тип данных конвертируемого значения.

Text_1 = String.VariantToLocalizedString(a, "double");

ValidateValue

string ValidateValue(string value, string dataType)

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

Входные параметры:

  • проверяемое значение;
  • проверяемый тип данных.

В качестве значения dataType можно указывать только названия типов данных языка Alpha.Om. Типы можно найти в документе на соответствующий продукт, либо в таблице, приведенной в описании функции CanonicalTypeToDataType (см. столбец Название типа). Также можно использовать значение, возвращаемое этой функцией.

Возвращает:

  • текст ошибки в случае ее возникновения;
  • пустую строку, если ошибки не возникает.

Вызов: Converter.ValidateValue("1234", "uint4")

ValidateRange

string ValidateRange(variant value, string dataType, variant min, variant max)

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

Входные параметры:

  • проверяемое значение;
  • тип данных проверяемого значения;
  • нижняя граница диапазона min; 
  • верхняя граница диапазона max.

Если не указать значения min и/или max, будут использоваться границы диапазона указанного типа данных.

В качестве значения dataType можно указывать только названия типов данных языка Alpha.Om. Типы можно найти в документе на соответствующий продукт, либо в таблице, приведенной в описании функции CanonicalTypeToDataType (см. столбец Название типа). Также можно использовать значение, возвращаемое этой функцией.

Возвращает:

  • текст ошибки в случае ее возникновения;
  • пустую строку, если ошибки не возникает.

Вызов: Converter.ValidateRange(123, "uint8", 1, 500)

ValidateValueRange

string ValidateValueRange(string value, string dataType, variant min, variant max)

Проверяет значение value, указанное в виде строки, на соответствие указанному типу данных dataType и на принадлежность допустимому диапазону от min до max.

Входные параметры:

  • проверяемое значение;
  • проверяемый тип данных;
  • нижняя граница диапазона min; 
  • верхняя граница диапазона max.

В качестве значения dataType можно указывать только названия типов данных языка Alpha.Om. Типы можно найти в документе на соответствующий продукт, либо в таблице, приведенной в описании функции CanonicalTypeToDataType (см. столбец Название типа). Также можно использовать значение, возвращаемое этой функцией.

Возвращает:

  • текст ошибки в случае ее возникновения;
  • пустую строку, если ошибки не возникает.

Вызов: Converter.ValidateValueRange(123, "uint8", 1, 500)

CanonicalTypeToDataType

string CanonicalTypeToDataType(uint1 canonicalType)

Вспомогательная функция. Возвращает название канонического типа данных, указанного в числовом виде. Возвращаемое значение можно использовать в качестве входного параметра dataType остальных функции Convert.

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

Таблица соответствия численного и текстового названий канонического типа данных
Число типа Название типа
0 "void"
1 "bool"
2 "int1"
3 "uint1"
4 "int2"
5 "uint2"
6 "int4"
7 "uint4"
8 "int8"
9 "uint8"
10 "float"
11 "double"
12 "timestamp"
14 "string"

Вызов: a = Converter.CanonicalTypeToDataType(3)

Результат: переменная a типа string, значение – uint1.

QualityCodeToString

string QualityCodeToString(uint4 quality)

Возвращает текстовое описание качества сигнала на основе числового кода качества сигнала.

Входной параметр – числовой код качества сигнала.

Описание состоит из трех значений:

  • качество сигнала;
  • числовой код;
  • дополнительное описание.

Код качества сигнала можно получить с помощью внутреннего аргумента или свойства экземпляра компонента Элемент AP <type>. Полученное значение можно использовать в качестве входного параметра функции QualityCodeToString().

Пример возвращаемого описания качества сигнала:

хорошее: 193 - Good (Low)

На основании возвращаемого значения, о сигнале можно сделать выводы:

  • сигнал имеет хорошее качество;
  • значение получено от источника с хорошим качеством;
  • качество сигнала усечено по нижней границе пересчета.

Описания числовых кодов качества сигнала можно найти в разделе "Качество сигналов" OPC DA Client модуля OPC DA документации на Alpha.Server. Более подробно о значениях дополнительного описания можно почитать в разделах "Сигналы Alpha.Server" и "Логическая обработка данных" документации на Alpha.Server.

GetVariantDataType

string GetVariantDataType(variant value)

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

Входной параметр – переменная типа variant.