Описание языка С++ в AgavaSCADA/AgavaPLC

Данное описание содержит базовое руководство по созданию программ на языке AgavaScript - диалекту языка С++ и их использованию в среде разработки Agava.

Дополнительные документы

• Описание базовых классов AgavaSCADA/AgavaPLC.
• Объектная модель AgavaSCADA/AgavaPLC.

Вы также можете ознакомиться с другими документами, размещенными в категории AgavaSCADA/AgavaPLC.

Основы синтаксиса

Все программы на языке С++ состоят из отдельных действий. Каждое действие заканчивается точкой с запятой:

int x;
x = 1;
int y = x + 2;

Для повышения удобства работы с кодом можно оставлять в нем комментарии, которые не используются при работе программы и предназначены для улучшения читаемости кода. Перед комментариями ставится «//»:

bool x = true;
// bool x = false;
// вторая строка не будет выполняться в программе

Переменные

Переменные – объекты, хранящиеся в памяти, над которыми и производятся действия в программе.

Для начала работы с переменной необходимо инициализировать ее, указав тип и имя, а затем, при необходимости, присвоить ей значение:

bool a = true;
int b = 1;
double c = 1.1;
string d = “строка”;

int f; // переменная инициализирована, значение не присвоено
f = 1; // присвоение значения

Ключевое слово auto при инициализации переменной может использоваться вместо типа переменной, для автоматического присвоения типа переменной исходя из инициализируемого значения.

auto a = true;
auto b = 1;

Строки

Строка – массив байтов или 16-битных слов. Обычно строки используются для хранения текста, но также могут хранить любые двоичные данные. Текст, хранящийся в строке, заключается в двойные кавычки.

При работе со строками доступны следующие функции:

Функция	Действие
uint length()	Возвращает длину строки
void resize(uint)	Устанавливает длину строки
bool isEmpty()	Возвращает истину, если строка пуста, т. е. длина равна нулю
string substr(uint start = 0, int count = -1)	Возвращает строку с содержимым, начинающимся с start, и количеством байтов, заданным параметром count. Аргументы по умолчанию вернут всю строку как новую строку
void insert(uint pos, const string &in other)	Вставляет другую строку string на позиции pos в исходной строке
void erase(uint pos, int count = -1)	Удаляет количество символов count из строки, начиная с позиции pos
int findFirst(const string &in str, uint start = 0)	Находит первое вхождение значения str в строке, начиная с символа под номером start. Если вхождения не найдено, будет возвращено отрицательное значение
int findFirstOf(const string &in str, uint start = 0)	Находит первое вхождение одного из символов в str в строке, начиная с символа под номером start. Если вхождения не найдено, будет возвращено отрицательное значение
int findLast(const string &in str, int start = -1)	Находит последнее вхождение значения str в строке
int findLastOf(const string &in str, int start = -1)	Находит последнее вхождение одного из символов в str в строке, начиная с символа под номером start. Если вхождения не найдено, будет возвращено отрицательное значение
string formatInt(int64 val, const string &in options = "", uint width=0)	Преобразование int в строку
string formatUInt(uint64 val, const string &in options = "", uint width=0)	Преобразование uint в строку
string formatFloat(double val, const string &in options="", uint width=0, uint precision=0)	Преобразование float и double в строку
int64 parseInt(const string &in str, uint base=10, uint &out byteCount=0)	Преобразование строки в int64
uint64 parseUInt(const string &in str, uint base=10, uint &out byteCount=0)	Преобразование строки в uint64
double parseFloat(const string &in str, uint &out byteCount=0)	Преобразование строки в double

Пример работы с функциями для строк:

string str = “ABCDEF”;          // инициализирована строка str

int a = str.length();           // a равно 6
int b = str.findFirst(“CD”, 0); // b равно 2

str.erase(1, 3);  // str равно “AEF”

string str = "НАСОС1";
string substrToRemove = "НАСОС";

int pos = str.findFirst(substrToRemove);

if (pos >= 0)
{
    str.erase(pos, substrToRemove.length());   // Теперь str содержит "1"
}

Массивы

Массив — многоэлементный тип данных, который позволяет получить доступ ко всем переменным одного и того же типа данных через использование одного идентификатора. Используется в том случае, если вам необходимо сгруппировать несколько элементов одного типа:

array <int> a = {2, 5, 10, 15, 20};  // инициализирован массив a с пятью элементами
int x = a [0];       // x становится равен элементу массива а под номером 0 (2)
int y = a [4];       // y становится равен элементу массива а под номером 4 (20)
arr [3] = 11;        // элемент массива а под номером 3 становится равен 11
int z = arr [3];      // z становится равен элементу массива а под номером 3 (11)

Важно помнить, что нумерация членов массива начинается с 0.

При работе с массивами доступны следующие функции:

Функция	Действие
length()	Возвращает длину массива
resize(uint)	Устанавливает новую длину массива
reverse()	Меняет порядок элементов в массиве на обратный
insertAt(uint index, const T& in value)	Вставляет новый элемент в массив по указанному индексу
insertLast(const T& in)	Добавляет элемент в конец массива
removeAt(uint index)	Удаляет элемент по указанному индексу
removeLast()	Удаляет последний элемент массива
removeRange(uint start, uint count)	Удаляет количество элементов count, начиная с элемента номер start
sortAsc ()	Сортирует элементы в массиве в порядке возрастания
sortDesc ()	Сортирует элементы в массиве в порядке убывания
find (const T &in)	Возвращает индекс первого элемента, который имеет то же значение, что и желаемое. Если совпадений не найдено, возвращает отрицательное значение

Пример работы с функциями для массивов:

int main()
{
  array<int> arr = {1,2,3}; // 1,2,3
  arr.insertLast(0);        // 1,2,3,0
  arr.insertAt(2,4);        // 1,2,4,3,0
  arr.removeAt(1);          // 1,4,3,0
  arr.sortAsc();            // 0,1,3,4
  int sum = 0;

  for( uint n = 0; n < arr.length(); n++ )
    sum += arr[n];

  return sum;
}

Перечисления

Перечисление — это тип данных, где любое значение определяется как символьная константа. Оно позволяет представить семейства целочисленных констант (например, коды ошибок) в текстовом виде вместо числового. Использование перечислений помогает улучшить читаемость кода, поскольку не нужно искать в руководстве, что означает числовое значение.

Значения перечислений объявляются путем их объявления в операторе перечисления. Если для константы перечисления не указано конкретное значение, она будет принимать значение предыдущей константы плюс 1. Первая константа получит значение 0, если не указано иное.

enum Errors
{
    NoError,         // = 0
    ReadError = 2,    // = 2
    WriteError,       // = 3
}

// теперь к константам перечисления можно обращаться через текстовое значение, например
// int a = NoError;

Типы переменных

Доступны логические, целочисленные, строковые переменные и переменные с плавающей запятой.

Логические переменные

Тип	Мин. значение	Макс. значение
bool	false (0)	true (1)

Целочисленные переменные

Тип	Мин. значение	Макс. значение
int8	- 128	127
int16	- 32 768	32 767
int	- 2 147 483 648	2 147 483 647
int64	- 9 223 372 036 854 775 808	9 223 372 036 854 775 807
uint8	0	255
uint16	0	65 535
uint	0	4 294 967 295
uint64	0	18 446 744 073 709 551 615

Переменные с плавающей запятой

Тип	Диапазон значений	Наименьшее значение
float	± 3.402823466 e+38	1.175494351 e-38
double	± 1.79769313486231 e+308	2.22507385850720 e-308

Операторы

Доступны операторы сравнения, логические, побитовые, арифметические, приращений и индексации.

Операторы сравнения

Оператор	Символ	Пример	Операция
Равно	==	x == y	true, если x равно y
Не равно	!=	x != y	true, если x не равно y
Меньше	<	x < y	true, если x меньше y
Больше	>	x > y	true, если x больше y
Меньше или равно	<=	x <= y	true, если x меньше или равно y
Больше или равно	>=	x >= y	true, если x больше или равно y

Логические операторы

Оператор	Символ	Пример	Операция
Логическое НЕ	!	!x	true, если x – false и false, если x – true
Логическое И	&&	x && y	true, если x и y – true, в противном случае – false
Логическое ИЛИ	||	x || y	true, если x или y – true, в противном случае – false
Логическое ИСКЛЮЧАЮЩЕЕ ИЛИ (XOR)	^	x ^ y	true, если x или y – true (но не одновременно), в противном случае – false

Побитовые операторы

Оператор	Символ	Пример	Операция
Побитовое И	&	x & y	Каждый бит в x И каждый соответствующий ему бит в y
Побитовое ИЛИ	|	x | y	Каждый бит в x ИЛИ каждый соответствующий ему бит в y
Побитовое ИСКЛЮЧАЮЩЕЕ ИЛИ (XOR)	^	x ^ y	Каждый бит в x XOR с каждым соответствующим ему битом в y
Побитовый сдвиг влево	<<	x << y	Все биты в x смещаются влево на y бит
Побитовый сдвиг вправо	>>	x >> y	Все биты в x смещаются вправо на y бит

Пример

float RegistersToFloat(uint16 r0, uint16 r1)
{
    // Создаем массив байтов в little-endian порядке
    array<uint8> bytes(4);
   
    // Little-endian (наиболее распространенный)
    bytes[0] = r0 & 0xFF;
    bytes[1] = (r0 >> 8) & 0xFF;
    bytes[2] = r1 & 0xFF;
    bytes[3] = (r1 >> 8) & 0xFF;

     // Преобразуем байты в uint32, затем в float
    uint32 resultBits = 0;   

    for (uint i = 0; i < 4; i++)
    {
        resultBits |= uint32(bytes[i]) << (i * 8);
    }   

    return fpFromIEEE(resultBits);
}

Арифметические операторы

Оператор	Символ	Пример	Операция
Сложение	+	x + y	Складываем x и y
Вычитание	-	x – y	Вычитаем y из x
Умножение	*	x * y	Умножаем x на y
Деление	/	x / y	Делим x на y
Присваивание	=	x = y	Присваиваем значение y переменной x
Сложение с присваиванием	+=	x += y	Добавляем y к x
Вычитание с присваиванием	-=	x -= y	Вычитаем y из x
Умножение с присваиванием	*=	x *= y	Умножаем x на y
Деление с присваиванием	/=	x /= y	Делим x на y

Операторы приращений

Операция инкремента увеличивает значение на 1, декремента – уменьшает на 1.

Оператор	Символ	Пример	Операция
Преинкремент	++	++х	Инкремент х, затем вычисление х
Предекремент	--	--х	Декремент х, затем вычисление х
Постинкремент	++	х++	Вычисление х, затем инкремент х
Постдекремент	--	х--	Вычисление х, затем декремент х

Оператор индексации

Используется для доступа к элементу.

Оператор	Символ	Пример	Операция
Индексация	[ ]	arr [0]	Обращение к нулевому элементу массива arr

Блоки выражений и область видимости переменных

Блоки выражений используются в условиях, циклах и функциях. При использовании вложенных блоков, блок, который содержит внутри себя другой блок, называется внешним блоком, а тот, который содержится внутри этого блока — внутренним / вложенным блок. Каждый блок заключается в фигурные скобки.

Внешние блоки не имеют доступа к переменным внутренних блоков.

{
    int a;
    float b;
    {
      float a = 1.0; // Отменить объявление внешней переменной
                     // но только в пределах внутреннего блока
      b = a;         // переменные из внешних блоков все еще доступны
      int c;
    }

    // a снова становится целочисленной переменной, b теперь равна 1.0, c здесь недоступна
  }

Условия

Операторы if/else

Позволяют выбрать выполнение нужных действий, в зависимости от выбранного условия, указанного в скобках:

if (x == 1)
{
  // эти действия выполнятся, если х равно 1
}
else 
{
  // эти действия выполнятся, если х не равно 1
}

Условное выражение (тернарный оператор)

Более короткая запись оператора выбора if/else:

x = 1 ? y = true : y = false;        // если х равно 1, тогда y равен true, иначе y равен false

Оператор switch

Является альтернативой if/else для тех случаев, когда необходимо сделать множественный выбор:

switch(x)
{
  case 0:
    // эти действия выполнятся, если х равно 0
    break;  // каждый case всегда должен заканчивать оператором break
  case 1:
    // эти действия выполнятся, если х равно 1
    break;
  case 2:
    // эти действия выполнятся, если х равно 2
    break;
  default:
    // Эти действия выполнятся, если x не равен ни одному из предыдущих значений case
  }

Циклы

Цикл while

Цикл выполняется, пока условие в скобках истинно:

x = 0;

while (x < 5)
{
    // это действие будет выполняться, пока х меньше 5
    x++;  // при каждом выполнении цикла увеличиваем х на 1
}

Цикл do while

Цикл похож на while, но, в отличии от него, цикл в любом случае выполнится хотя бы один раз (или больше, если при последующих проверках условие будет истинно):

x = 10;

do
{
   // это действие выполнится один раз, так как условие изначально ложно
}
while (x < 5);

Цикл for

Цикл for обычно используется как счетчик и хорошо подходит, когда известно необходимое количество итераций. В скобках через точку с запятой указывается переменная, условие, инкремент / декремент для переменной:

for ( int x = 0; x < 5; x ++ )
{
    // при каждом выполнении этих действий переменная х будет увеличивать на 1
    // действия будут выполняться пока х меньше 5
}

Функции

Функция — это последовательность действия для выполнения определенного задания. Объявление функции похоже на объявление переменной: необходимо указать тип возвращаемого значения (либо void, если функция ничего не возвращает) и название функции. После этого ставятся двойные скобки, в которых находятся аргументы функции (либо пустые скобки, если аргументы отсутствуют). Действия, выполняемые функцией, заключаются в фигурные скобки.

Любой код в операции «Скрипт С++» должен находиться в функции. При использовании нескольких функций в скрипте будет выполняться только первая, остальные должны быть вызваны из нее:

void main ()
{
  int x = 1;
  function ();  // вызов функции, программа переходит в void function()
  SetNodeValueAsInt(“/Конфигурация/Станция/Сигналы/Constant2”, x);
}

void function ()
{
  SetNodeValueAsInt(“/Конфигурация/Станция/Сигналы/Constant2”, 5);
  // теперь программа возвращается обратно в void main()
}

После выполнения данного скрипта значение сигнала Constant1 станет равно 5, а Constant2 равно 1.

Если переменная была объявлена в функции, то она не будет доступна за ее пределами.

Функции с параметрами

Параметр функции — это переменная, которая используется в функции, и значение которой предоставляет вызывающий функцию объект.

Параметры указываются при объявлении функции в круглых скобках:

void summ (int x, int y)  // в функцию передаются параметры х = 1 и y = 2
{
  int z = x + y;  // z равно 3
}

Возврат значения

Для передачи значения из скрипта можно указать необходимое значение в действии return, указав тип функции такой же, как у возвращаемого значения:

bool R_Output (bool x, bool y)
{
  bool z = false;
  z = x && y;

  return z; // z передается на выход скрипта
}

Классы

• Класс any.
• Класс datetime.
• Класс file.
• Класс filesystem.

Классы объектной модели:

• Базовые классы AgavaSCADA/AgavaPLC.
• Класс SystemAlarming.
• Классы для рисования и работы с графическим интерфейсом.

Приоритет операций

В выражениях первым всегда вычисляется оператор с наивысшим приоритетом. Унарные операторы имеют более высокий приоритет, чем другие операторы. Постоператоры имеют более высокий приоритет, чем преоператоры.

В этой таблице показаны доступные унарные операторы, в порядке убывания приоритета.

Символ	Операция
::	Оператор разрешения области видимости
[]	Оператор индексации
++ --	Постинкремент и декремент
.	Доступ
++ --	Преинкремент и декремент
!	Логическое НЕ
+ -	Унарный положительный и отрицательный
~	Побитовое дополнение
@	Ссылка

Эта таблица показывает приоритет бинарных и тернарных операторов в порядке убывания.

Символ	Операция
**	Экспонента
* / %	Умножить, разделить, по модулю
+ -	Сложить и вычесть
<< >> >>>	Сдвиг влево, сдвиг вправо и арифметический сдвиг вправо
&	Битовое И
^	Битовый XOR
|	Битовое ИЛИ
<= < >= >	Сравнение
== != is !is xor ^^	Равенство, идентичность и логическое исключающее ИЛИ
and &&	Логическое И
or ||	Логическое ИЛИ
?:	Условие
= += -= *= /= %= **= &= |= ^= <<= >>= >>>=	Присваивание и составные присваивания

Зарезервированные ключевые слова

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

and abstract auto bool break case cast catch class const continue default do

double else enum explicit external false final float for from funcdef function get

if import in inout int interface int8 int16 int32 int64 is mixin namespace

not null or out override private property protected return set shared super switch

this true try typedef uint uint8 uint16 uint32 uint64 void while xor