Описание базовых классов AgavaSCADA/AgavaPLC: различия между версиями

Материал из docs.kb-agava.ru
Перейти к навигации Перейти к поиску
 
(не показано 17 промежуточных версий этого же участника)
Строка 1: Строка 1:
 
В данном документе описываются свойства, поля и методы базовых классов AgavaPLC/AgavaSCADA, взаимодействие с которыми доступно в функциях, классах и программах приложений.
 
В данном документе описываются свойства, поля и методы базовых классов AgavaPLC/AgavaSCADA, взаимодействие с которыми доступно в функциях, классах и программах приложений.
−
 
+
[[Файл:Иерархия классов объектной модели AgavaPLC 1.6.png|альт=|мини|Иерархия классов объектной модели AgavaPLC 1.6]]
 
Данный документ применим к AgavaSCADA/AgavaPLC версии 1.5 и старше (новее).
 
Данный документ применим к AgavaSCADA/AgavaPLC версии 1.5 и старше (новее).
  
 
==BasicNode==
 
==BasicNode==
 +
Базовый класс для всех узлов проекта.
 +
 
Предок: нет.
 
Предок: нет.
  
 
=== Конструкторы ===
 
=== Конструкторы ===
 +
BasicNode::BasicNode()              ///< Конструктор по умолчанию
 
  BasicNode::BasicNode(string path)    ///< Создание узла по пути в проекте
 
  BasicNode::BasicNode(string path)    ///< Создание узла по пути в проекте
  
 
===Методы===
 
===Методы===
−
  string BasicNode::GetName()
+
  string BasicNode::GetName()         ///< Получение имени узла
−
  string BasicNode::GetShortName()
+
  string BasicNode::GetShortName()     ///< Получение шифра узла
−
  string BasicNode::GetDescription()
+
  string BasicNode::GetDescription()   ///< Получение описания узла
  
 
  void BasicNode::SetName(string name)
 
  void BasicNode::SetName(string name)
Строка 18: Строка 21:
 
  void BasicNode::SetDescription(string description)
 
  void BasicNode::SetDescription(string description)
  
−
  string BasicNode::GetPath()     ///< Получение пути узла в проекте
+
  string BasicNode::GetPath()         ///< Получение пути узла в проекте
 +
 
 +
void BasicNode::Start()              ///< Запуск узла
 +
void BasicNode::Stop()              ///< Остановка узла
 +
 
 +
NodeProperty@ BasicNode::GetProperty(string& prop)    ///< Получение указателя на свойство узла
 +
void BasicNode::PropertyValueUpdated(string& prop)    ///< Сигнализация об обновлении значения свойства
 +
 
 +
=== Свойства ===
 +
{|style="width:75%" class="wikitable"
 +
|+
 +
!style="width:15%"|Имя
 +
!style="width:25%"|Описание
 +
!style="width:10%"|Тип
 +
!style="width:15%"|Доступ
 +
!Внутренний идентификатор
 +
|-
 +
|Id
 +
|Идентификатор узла
 +
|int
 +
|Чтение/Запись
 +
|CONFIGNODE_PARAM_ID
 +
|-
 +
|Name
 +
|Имя узла
 +
|string
 +
|Чтение/Запись
 +
|CONFIGNODE_PARAM_NAME
 +
|-
 +
|Description
 +
|Описание узла
 +
|string
 +
|Чтение/Запись
 +
|CONFIGNODE_PARAM_DESCRIPTION
 +
|-
 +
|ShortName
 +
|Шифр узла
 +
|string
 +
|Чтение/Запись
 +
|CONFIGNODE_PARAM_SHORTNAME
 +
|-
 +
|NodeDisabled
 +
|Узел выключен
 +
|bool
 +
|Чтение/Запись
 +
|CONFIGNODE_PARAM_DISABLED
 +
|}
  
−
void BasicNode::Start()
 
−
void BasicNode::Stop()
 
 
==SignalValue==
 
==SignalValue==
 +
Класс, хранящий значение, передаваемое между узлами.
 +
 
Предок: нет.
 
Предок: нет.
  
 
=== Конструкторы ===
 
=== Конструкторы ===
 +
SignalValue::SignalValue(string value)
 
  SignalValue::SignalValue(int value)
 
  SignalValue::SignalValue(int value)
 
  SignalValue::SignalValue(double value)
 
  SignalValue::SignalValue(double value)
−
  SignalValue::SignalValue(string value)
+
  SignalValue::SignalValue(bool value)
  
 
===Методы===
 
===Методы===
 
  string SignalValue::ToString()  ///< Преобразовать значение в строку
 
  string SignalValue::ToString()  ///< Преобразовать значение в строку
 +
int SignalValue::ToInt()        ///< Преобразовать значение в int
 
  double SignalValue::ToDouble()  ///< Преобразовать значение в double
 
  double SignalValue::ToDouble()  ///< Преобразовать значение в double
−
  int SignalValue::ToInt()         ///< Преобразовать значение в int
+
  bool SignalValue::ToBool()       ///< Преобразовать значение в bool
  
 
  void SignalValue::SetValue(string& value)
 
  void SignalValue::SetValue(string& value)
 
  void SignalValue::SetValue(int value)
 
  void SignalValue::SetValue(int value)
 
  void SignalValue::SetValue(double value)
 
  void SignalValue::SetValue(double value)
 +
void SignalValue::SetValue(bool value)
  
 
  bool SignalValue::IsNumber()    ///< Значение является числовым
 
  bool SignalValue::IsNumber()    ///< Значение является числовым
Строка 62: Строка 114:
 
  }
 
  }
  
−
==BasicSource==
+
== NodeProperty ==
−
Предок: BasicNode.
+
Класс, предоставляющий доступ к свойствам узлов.
 +
 
 +
Предок: нет.
 +
 
 +
=== Конструкторы ===
 +
NodeProperty::NodeProperty()
 +
NodeProperty::NodeProperty(NodeProperty& other)
 +
 
 +
===Методы===
 +
string NodeProperty::GetName()        ///< Получение имени свойства
 +
string NodeProperty::GetShortName()    ///< Получение шифра свойства
 +
string NodeProperty::GetDescription()  ///< Получение описания свойства
 +
string NodeProperty::GetTitle()        ///< Получение заголовка свойства
 +
 
 +
string NodeProperty::ToString()        ///< Преобразование значения свойства в строку
 +
int NodeProperty::ToInt()              ///< Преобразование значения свойства в число типа int
 +
double NodeProperty::ToDouble()        ///< Преобразование значения свойства в число типа double
 +
bool NodeProperty::ToBool()            ///< Преобразование значения свойства в булевское значение
 +
 
 +
int NodeProperty::SetValue(string val) ///< Установка значения свойства
 +
int NodeProperty::SetValue(int val)    ///< Установка значения свойства
 +
int NodeProperty::SetValue(double val) ///< Установка значения свойства
 +
int NodeProperty::SetValue(bool val)  ///< Установка значения свойства
 +
 
 +
=== Примеры ===
 +
BasicNode node("/Root/node");
 +
NodeProperty@ prop = node.GetProperty("ShortName");
 +
 +
string sn2 = prop.ToString();
 +
prop.SetValue(string(sn2+"ShortName1"));
 +
 
 +
== BasicSource ==
 +
Предок: [[Описание базовых классов AgavaSCADA/AgavaPLC#BasicNode|BasicNode]].
 
===Методы===
 
===Методы===
−
  SignalValue BasicSource::GetValue()          ///< Получение значения.
+
  '''SignalValue BasicSource::GetValue()'''         ///< Получение значения.
−
  int BasicSource::SetValue(SignalValue sv)    ///< Установка собственного значения с установкой значений связанных узлов (источников).
+
Метод производит получение значения источника.
−
  int BasicSource::UpdateValue(SignalValue sv) ///< Установка собственного значения.
+
 
 +
Результат - значение типа [[Описание базовых классов AgavaSCADA/AgavaPLC#SignalValue|SignalValue]].
 +
 
 +
  '''int BasicSource::SetValue(SignalValue sv)'''    ///< Установка собственного значения с установкой значений связанных узлов (в транспорте).
 +
Метод производит установку нового значения источника. Если источник связан с транспортом, то транспорт выполнит передачу нового значения в связанное с ним внешнее устройство.
 +
 
 +
Результат - [[Коды ошибок и предупреждений AgavaSCADA/AgavaPLC|код выполнения операции]].
 +
 
 +
'''int BasicSource::UpdateValue(SignalValue sv)''' ///< Установка собственного значения.
 +
Метод производит установку нового значения источника без передачи значения транспорту.
 +
 
 +
Результат - [[Коды ошибок и предупреждений AgavaSCADA/AgavaPLC|код выполнения операции]].
 +
 
 +
==BasicSignal==
 +
Предок:  [[#BasicSource|BasicSource]].
 +
===Методы===
 +
'''SignalValue BasicSignal::GetValue()'''          ///< Получение значения.
 +
Метод производит получение значения сигнала.
 +
 
 +
Результат - значение типа [[Описание базовых классов AgavaSCADA/AgavaPLC#SignalValue|SignalValue]].
 +
 
 +
'''int BasicSignal::SetValue(SignalValue sv)'''   ///< Установка собственного значения с установкой значений связанных узлов (источников).
 +
Метод производит установку нового значения сигнала. Если сигнал связан с источником (или несколькими источниками), то будет выполнена передача нового значения в источник(-и).
 +
 
 +
Результат - [[Коды ошибок и предупреждений AgavaSCADA/AgavaPLC|код выполнения операции]].
 +
 
 +
  '''int BasicSignal::UpdateValue(SignalValue sv)''' ///< Установка собственного значения.
 +
Метод производит установку нового значения источника без передачи значения источнику.
 +
 
 +
Результат - [[Коды ошибок и предупреждений AgavaSCADA/AgavaPLC|код выполнения операции]].
 +
 
 
==ModbusRegister==
 
==ModbusRegister==
−
Предок: BasicSource.
+
Предок: [[#BasicSource|BasicSource]].
 
===Поля===
 
===Поля===
 
  uint8  m_ucDeviceNo        ///< Номер устройства.
 
  uint8  m_ucDeviceNo        ///< Номер устройства.
Строка 77: Строка 191:
 
  uint16 m_wWriteRegisterNo  ///< Номер регистра записи.
 
  uint16 m_wWriteRegisterNo  ///< Номер регистра записи.
 
  uint8  m_ucSize            ///< Размер регистра в битах.
 
  uint8  m_ucSize            ///< Размер регистра в битах.
−
  uint8  m_ucPriority        ///< Приоритет. 0 - максимальный. Не используется.
+
  uint8  m_ucPriority        ///< Приоритет. Не используется.
 
===Методы===
 
===Методы===
 
  int BasicSource::WriteValue(SignalValue sv) ///< Установка собственного значения с записью значения в устройство.
 
  int BasicSource::WriteValue(SignalValue sv) ///< Установка собственного значения с записью значения в устройство.
−
==<s>BasicWindow</s>==
+
==BasicWidget==
−
===<s>Методы</s>===
+
Предок: [[Описание базовых классов AgavaSCADA/AgavaPLC#BasicNode|BasicNode]].
−
  <s>void BasicWindow::Show()  ///< Отображение окна.
+
 
−
  void BasicWindow::Hide()  ///< Сокрытие окна.</s>
+
===Методы===
−
+
void BasicWidget::Repaint()                ///< Перерисовка виджета
 +
 
 +
=== Обработчики ===
 +
void BasicWidget::OnPaint(Painter@ painter)              ///< Обработчик отрисовки виджета
 +
void BasicWidget::OnMousePress(MouseEvent@ event)        ///< Обработчик нажатия кнопки мыши
 +
void BasicWidget::OnMouseRelease(MouseEvent@ event)      ///< Обработчик отпускания кнопки мыши
 +
void BasicWidget::OnMouseDoubleClick(MouseEvent@ event)  ///< Обработчик двойного нажатия кнопки мыши
 +
void BasicWidget::OnMouseMove(MouseEvent@ event)        ///< Обработчик перемещения курсора мыши над виджетом
 +
void BasicWidget::OnMouseEnter()                        ///< Обработчик входа курсора мыши в область над виджетом
 +
void BasicWidget::OnMouseLeave()                        ///< Обработчик выхода курсора мыши из области над виджетом
 +
void BasicWidget::OnWheel(WheelEvent@ event)            ///< Обработчик прокрутки колеса мыши при нахождении курсора мыши в области над виджетом
 +
 
 +
== BasicWindow ==
 +
Предок: [[Описание базовых классов AgavaSCADA/AgavaPLC#BasicWidget|BasicWidget]].
 +
 
 +
===Методы===
 +
  void BasicWindow::Show()  ///< Отображение окна.
 +
  void BasicWindow::Hide()  ///< Сокрытие окна.
 
[[Категория:AgavaSCADA/AgavaPLC]]
 
[[Категория:AgavaSCADA/AgavaPLC]]

Текущая версия на 10:43, 23 октября 2025

В данном документе описываются свойства, поля и методы базовых классов AgavaPLC/AgavaSCADA, взаимодействие с которыми доступно в функциях, классах и программах приложений.

Иерархия классов объектной модели AgavaPLC 1.6

Данный документ применим к AgavaSCADA/AgavaPLC версии 1.5 и старше (новее).

1 BasicNode

Базовый класс для всех узлов проекта.

Предок: нет.

1.1 Конструкторы

BasicNode::BasicNode()               ///< Конструктор по умолчанию
BasicNode::BasicNode(string path)    ///< Создание узла по пути в проекте

1.2 Методы

string BasicNode::GetName()          ///< Получение имени узла
string BasicNode::GetShortName()     ///< Получение шифра узла
string BasicNode::GetDescription()   ///< Получение описания узла

void BasicNode::SetName(string name)
void BasicNode::SetShortName(string shortname)
void BasicNode::SetDescription(string description)

string BasicNode::GetPath()          ///< Получение пути узла в проекте

void BasicNode::Start()              ///< Запуск узла
void BasicNode::Stop()               ///< Остановка узла

NodeProperty@ BasicNode::GetProperty(string& prop)     ///< Получение указателя на свойство узла
void BasicNode::PropertyValueUpdated(string& prop)     ///< Сигнализация об обновлении значения свойства

1.3 Свойства

Имя Описание Тип Доступ Внутренний идентификатор
Id Идентификатор узла int Чтение/Запись CONFIGNODE_PARAM_ID
Name Имя узла string Чтение/Запись CONFIGNODE_PARAM_NAME
Description Описание узла string Чтение/Запись CONFIGNODE_PARAM_DESCRIPTION
ShortName Шифр узла string Чтение/Запись CONFIGNODE_PARAM_SHORTNAME
NodeDisabled Узел выключен bool Чтение/Запись CONFIGNODE_PARAM_DISABLED

2 SignalValue

Класс, хранящий значение, передаваемое между узлами.

Предок: нет.

2.1 Конструкторы

SignalValue::SignalValue(string value)
SignalValue::SignalValue(int value)
SignalValue::SignalValue(double value)
SignalValue::SignalValue(bool value)

2.2 Методы

string SignalValue::ToString()   ///< Преобразовать значение в строку
int SignalValue::ToInt()         ///< Преобразовать значение в int
double SignalValue::ToDouble()   ///< Преобразовать значение в double
bool SignalValue::ToBool()       ///< Преобразовать значение в bool

void SignalValue::SetValue(string& value)
void SignalValue::SetValue(int value)
void SignalValue::SetValue(double value)
void SignalValue::SetValue(bool value)

bool SignalValue::IsNumber()     ///< Значение является числовым
bool SignalValue::IsError()      ///< Значение является ошибкой

2.3 Примеры

void fnIncrementSource(BasicSource_t &source)
{
    SignalValue sv = source.GetValue();
    
    if (sv.IsNumber() == true)
    {
        int iVal = sv.ToInt();
        iVal++;

        sv = SignalValue(iVal);
    }
    else
    {
        sv = SignalValue(0);
    }

    source.SetValue(sv);
}

3 NodeProperty

Класс, предоставляющий доступ к свойствам узлов.

Предок: нет.

3.1 Конструкторы

NodeProperty::NodeProperty()
NodeProperty::NodeProperty(NodeProperty& other)

3.2 Методы

string NodeProperty::GetName()         ///< Получение имени свойства
string NodeProperty::GetShortName()    ///< Получение шифра свойства
string NodeProperty::GetDescription()  ///< Получение описания свойства
string NodeProperty::GetTitle()        ///< Получение заголовка свойства

string NodeProperty::ToString()        ///< Преобразование значения свойства в строку
int NodeProperty::ToInt()              ///< Преобразование значения свойства в число типа int
double NodeProperty::ToDouble()        ///< Преобразование значения свойства в число типа double
bool NodeProperty::ToBool()            ///< Преобразование значения свойства в булевское значение

int NodeProperty::SetValue(string val) ///< Установка значения свойства
int NodeProperty::SetValue(int val)    ///< Установка значения свойства
int NodeProperty::SetValue(double val) ///< Установка значения свойства
int NodeProperty::SetValue(bool val)   ///< Установка значения свойства

3.3 Примеры

BasicNode node("/Root/node");
NodeProperty@ prop = node.GetProperty("ShortName");

string sn2 = prop.ToString();
prop.SetValue(string(sn2+"ShortName1"));

4 BasicSource

Предок: BasicNode.

4.1 Методы

SignalValue BasicSource::GetValue()          ///< Получение значения.

Метод производит получение значения источника.

Результат - значение типа SignalValue. 

int BasicSource::SetValue(SignalValue sv)    ///< Установка собственного значения с установкой значений связанных узлов (в транспорте).

Метод производит установку нового значения источника. Если источник связан с транспортом, то транспорт выполнит передачу нового значения в связанное с ним внешнее устройство.

Результат - код выполнения операции. 

int BasicSource::UpdateValue(SignalValue sv) ///< Установка собственного значения.

Метод производит установку нового значения источника без передачи значения транспорту.

Результат - код выполнения операции.

5 BasicSignal

Предок: BasicSource.

5.1 Методы

SignalValue BasicSignal::GetValue()          ///< Получение значения.

Метод производит получение значения сигнала.

Результат - значение типа SignalValue. 

int BasicSignal::SetValue(SignalValue sv)    ///< Установка собственного значения с установкой значений связанных узлов (источников).

Метод производит установку нового значения сигнала. Если сигнал связан с источником (или несколькими источниками), то будет выполнена передача нового значения в источник(-и).

Результат - код выполнения операции. 

int BasicSignal::UpdateValue(SignalValue sv) ///< Установка собственного значения.

Метод производит установку нового значения источника без передачи значения источнику.

Результат - код выполнения операции.

6 ModbusRegister

Предок: BasicSource.

6.1 Поля

uint8  m_ucDeviceNo        ///< Номер устройства.
uint8  m_ucReadFunctionNo  ///< Номер функции чтения.
uint16 m_wReadRegisterNo   ///< Номер регистра чтения.
uint8  m_ucWriteFunctionNo ///< Номер функции записи.
uint16 m_wWriteRegisterNo  ///< Номер регистра записи.
uint8  m_ucSize            ///< Размер регистра в битах.
uint8  m_ucPriority        ///< Приоритет. Не используется.

6.2 Методы

int BasicSource::WriteValue(SignalValue sv) ///< Установка собственного значения с записью значения в устройство.

7 BasicWidget

Предок: BasicNode.

7.1 Методы

void BasicWidget::Repaint()                ///< Перерисовка виджета

7.2 Обработчики

void BasicWidget::OnPaint(Painter@ painter)              ///< Обработчик отрисовки виджета
void BasicWidget::OnMousePress(MouseEvent@ event)        ///< Обработчик нажатия кнопки мыши
void BasicWidget::OnMouseRelease(MouseEvent@ event)      ///< Обработчик отпускания кнопки мыши
void BasicWidget::OnMouseDoubleClick(MouseEvent@ event)  ///< Обработчик двойного нажатия кнопки мыши
void BasicWidget::OnMouseMove(MouseEvent@ event)         ///< Обработчик перемещения курсора мыши над виджетом
void BasicWidget::OnMouseEnter()                         ///< Обработчик входа курсора мыши в область над виджетом
void BasicWidget::OnMouseLeave()                         ///< Обработчик выхода курсора мыши из области над виджетом
void BasicWidget::OnWheel(WheelEvent@ event)             ///< Обработчик прокрутки колеса мыши при нахождении курсора мыши в области над виджетом

8 BasicWindow

Предок: BasicWidget.

8.1 Методы

void BasicWindow::Show()  ///< Отображение окна.
void BasicWindow::Hide()  ///< Сокрытие окна.
Источник — https://docs.kb-agava.ru/index.php?title=Описание_базовых_классов_AgavaSCADA/AgavaPLC&oldid=3264