Данный документ представляет собой описание интерфейса программирования приложения (API) системы OpenSCADA.

OpenSCADA это проект открытой SCADA-системы построенной по модульному принципу. В документе содержится исчерпывающее описание внутренней архитектуры системы OpenSCADA. Кроме информации об архитектуре предоставляются справочные данные по методам и атрибутам объектов системы.

Документ предназначен для программистов желающих разобраться в архитектуре OpenSCADA и разрабатывать расширения для неё. Документ не предназначен для пользователей и интеграторов OpenSCADA!

Для понимания документа требуется знание концепции Объектно Ориентированного Программирования (ООП) и универсального языка моделирования программного обеспечения (UML), а для возможности изучения исходного кода проекта требуется знание языка программирования C++. Кроме того, в документе содержится упоминание о технологиях: реляционные БД, XML.

1. Внутренняя структура, API системы OpenSCADA.

С целью наглядного и доступного восприятия архитектуры системы OpenSCADA в целом на рис.1. изображена статическая диаграмма классов системы OpenSCADA на универсальном языке моделирования (UML). Исходя из диаграммы видно, что система OpenSCADA содержит модульные подсистемы: "Архивы", "Базы данных", "Транспорты", "Транспортные протоколы", "Пользовательские интерфейсы", "Сбор данных" и "Специальные", а также подсистемы: "Безопасность" и "Управление модулями". На диаграмме наглядно представлены взаимосвязи между модульными подсистемами и модулями соответствующих типов.

Рис. 1. Статическая диаграмма классов

2. Общая структура системы. Модульность (TSubSYS, TModule)

Корнем, от которого строится вся система, является объект TSYS. Корень содержит подсистемы (TSubSYS). Подсистемы могут быть: обычными и модульными. Отличие модульных подсистем четко прослеживается на рис. 1. Так, модульные подсистемы обязательно содержат список модульных объектов (TModule), например подсистема архивы TArchiveS содержит модульные объекты TTypeArchivator. В тоже время обычная подсистема таких объектов не содержит. Например, подсистема безопасности TSeсurity (рис.2).

Иерархическая структура системы OpenSCADA (21 Кб)

Рис. 2. Иерархическая структура системы OpenSCADA.

В процессе инициализации корня (TSYS) определяется глобальная переменная SYS. Переменная SYS может использоваться для прямого обращения к корню системы из любого её узла. Инициализация корня выполняется единожды из главной вызывающей функции. После запуска управление захватывается объектом системы до остановки. Корневой объект концентрирует все общесистемные функции системы OpenSCADA.

Продолжением корневого объекта (TSYS), выполняющего функции обслуживания потока системных сообщений, выступает объект TMess. Объект доступен посредством глобальной переменной Mess, которая инициализируется корнем системы. Объект содержит функции кодирования, декодирования и локализации сообщений.

В подсистемах (TSubSYS) реализуются функции характерные для каждой подсистемы индивидуально, с общим для всех подсистем доступом, через объект TSubSYS. Модульная подсистема имеет возможность расширять функциональность посредством модулей. Для этой цели модульная подсистема предоставляет доступ к модулям своего типа в виде модульных объектов.

Модуль — составная часть модульной подсистемы. В общем, для всех модулей и их подсистем, модуль предоставляет информацию о себе, своём происхождении и экспортируемых функциях. Отдельно взятый модуль реализует функциональность в соответствии со своими потребностями.

2.1. Корневой объект системы (TSYS)

Наследует:

TCntrNode.

Данные:
Информационные переменные программы:

PACKAGE_LICENSE — Лицензия распространения программы
PACKAGE_DESCR — Краткое описание программы
PACKAGE_AUTHOR — Автор программы
PACKAGE_SITE — Web сайт поддержки программы

Способы кодирования символьных последовательностей (enum — TSYS::Code):

PathEl — элемент пути (символы: '/' и '%' к виду '%2f');
HttpURL — адрес браузера (http url);
Html — специальных символов для использования в html;
JavaSc — символов конца строки для JavaScript;
SQL — значения SQL-запросов;
Custom — выборочное кодирование указанных символов;
base64 — Mime кодирование в стандарте Base64;
FormatPrint — Кодирование/экранирование элементов форматирования для функций вроде "printf";
oscdID — Кодирование идентификаторов узлов.
Bin — Кодирование бинарных данных в текст и обратно.
Reverse — Инверсия порядка символов в строке.
ShieldSimb — Кодирование экранированных символов вроде "\n" в реальные коды.
ToLower — Преобразование в нижний регистр.

Виды представления целого в функциях TSYS::int2str() и TSYS::ll2str() (enum — TSYS::IntView):

Dec — десятичное;
Oct — восьмеричное;
Hex — шестнадцатеричное.

Структура задачи OpenSCADA (class — TSYS::STask):

STask( pthread_t ithr, char ipolicy, char iprior ); — конструктор описателя задачи для потока ithr, его политики планирования ipolicy и приоритета iprior.
float consumpt( ) const; — последнее использование времени процессора, в секундах.
float period( ); — мгновенная периодичность вызова задачи, в секундах.
string path; — путь.
pthread_t thr; — указатель потока.
uint8_t policy, prior; — политика и приоритет планирования.
pid_t tid; — идентификатор потока как идентификатор процесса Linux.
ResString cpuSet; — перечень использованных процессоров/ядер.
void *(*task) (void *); — указатель на задачу.
void *taskArg; — аргументы задачи.
unsigned flgs; — флаги, "enum Flgs { Detached = 0x01, FinishTask = 0x02; }"
int64_t tm_beg, tm_end, tm_per, tm_pnt, cycleLost, lagMax, consMax; — переменные статистики исполнения задачи.

Структура резервной станции (class — TSYS::SStat):

int8_t lev; — уровень станции;
bool isLive; — признак "Станиця Жива";
float cnt; — счётчик запросов к резервной станции или таймер повторной попытки подключения;
SStat( int8_t ilev, bool iisLive = false, float icnt = 0 ) — конструктор объекта станции с уровнем ilev, инициированная как "живая" iisLive и счётчиком icnt;
SStat( ) — конструктор по умолчанию, инициируется как отсутствующая и неактивная станция;
bool isActive( ) — станция активна.

Шаблоны/определения:

USER_FILE_LIMIT — Лимит на размер файлов для пользовательской загрузки (1 МБ).
STR_BUF_LEN — Стандартная длина строковых буферов (10000).
NSTR_BUF_LEN — Стандартная длина строковых буферов, для чисел (100).
STD_WAIT_DELAY — Стандартный квант времени циклов ожидания (100 мс).
STD_CACHE_LIM — Стандартное ограничение кеша (100).
STD_WAIT_TM — Стандартный интервал ожидания события (10 мс).
STD_INTERF_TM — Таймаут, максимальное время, ожидания реакции интерфейса (5 с).
BUF_ARCH_NM — Имя буфера архива ("<buffer>").
ALRM_ARCH_NM — Имя таблицы нарушений ("<alarms>").
__func__ — Полное имя вызывающей функции.
vmin(a, b) — Определение минимального значения.
vmax(a, b) — Определение максимального значения.

Публичные методы:

TSYS( int argi, char **argb, char **env ); — Инициализирующий конструктор.
void unload( ); — Выгрузка подсистем.
int start( ); — Запуск системы. Функция завершается только с завершением работы системы. Возвращается код возврата.
void stop( int sig = SIGUSR1 ); — Останов программы сигналом sig, по умолчанию SIGUSR1 и SIGUSR2 зарезервирован для менеджера проектов.
int stopSignal( ); — Код возврата в случае останова системы. Может использоваться как признак "Останов системы" различными подсистемами.
string id( ); — Идентификатор станции.
string name( ); — Локализованное имя станции.
string user( ); — Системный пользователь от имени которого запущена система.
string host( ); — Имя хоста на котором исполняется станция.
void list( vector<string> &list ) const; — Список подсистем зарегистрированных в системе.
bool present( const string &name ) const; — Проверка на наличие указанной подсистемы.
void add( TSubSYS *sub ); — Добавление/регистрация подсистемы.
void del( const string &name ); — Удаление подсистемы.
AutoHD<TSubSYS> at( const string &name ) const; — Подключение к указанной подсистеме.
AutoHD<TUIS> ui( ); — Прямой доступ к подсистеме "Пользовательские интерфейсы".
AutoHD<TArchiveS> archive( ); — Прямой доступ к подсистеме "Архивы".
AutoHD<TBDS> db( ); — Прямой доступ к подсистеме "Базы данных".
AutoHD<TControllerS> daq( ); — Прямой доступ к подсистеме "Сбор данных".
AutoHD<TProtocolS> protocol( ); — Прямой доступ к подсистеме "Протоколы".
AutoHD<TTransportS> transport( ); — Прямой доступ к подсистеме "Транспорты".
AutoHD<TSpecialS> special( ); — Прямой доступ к подсистеме "Специальные".
AutoHD<TModSchedul> modSchedul( ); — Прямой доступ к подсистеме "Управление модулями".
AutoHD<TSeсurity> seсurity( ); — Прямой доступ к подсистеме "Безопасность".
string workDir( ); — Рабочая директория станции.
string modDir( ); — Директории с модулями OpenSCADA, разделённые ';', которые могут включать шаблоны файлов, в конце (/my/modules/path/lib*.so).
string icoDir( ); — Директория иконок OpenSCADA.
string docDir( ); — Директория документов OpenSCADA.
void setWorkDir( const string &wdir, bool init = false ); — Установка рабочей директории станции.
void setModDir( const string &mdir, bool init = false ); — Установка директорий модулей OpenSCADA.
void setIcoDir( const string &idir, bool init = false ); — Установка директории иконок OpenSCADA.
void setDocDir( const string &idir, bool init = false ); — Установка директории документов OpenSCADA.
string cfgFile( ); — Имя конфигурационного файла системы.
XMLNode &cfgRoot( ); — Разобранная структура конфигурационного файла.
XMLNode *cfgNode( const string &path, bool create = false ); — Получение узла конфигурации по его пути path. Создавать элементы пути в случае их отсутствии create.
void modifCfg( bool chkPossibleWR = false ); — Отметка модификации конфигурации или проверка на возможность записи chkPossibleWR, для последующего сохранения в файл.
string workDB( ); — Полное имя рабочей БД.
string selDB( ); — Выбранная БД. Используется для избирательной загрузки из указанной БД, в подсистеме "БД".
string mainCPUs( ); — Список используемых процессоров.
bool clockRT( ); — Выбор часов реального времени для планирования задач, иначе используются монотонные (по умолчанию).
bool saveAtExit( ); — Признак - "Сохранять конфигурацию системы при выходе".
int savePeriod( ); — Периодичность автоматического сохранения станции в БД (секунд).
void setWorkDB( const string &wdb ); — Установка полного имени рабочей БД.
void setSelDB( const string &vl ); — Установка выбранной БД для избирательной загрузки.
void setMainCPUs( const string &vl ); — Установка списока используемых процессоров.
void setClockRT( bool vl ); — Установка выбора часов реального времени для планирования задач.
void setSaveAtExit( bool vl ); — Установка признака - "Сохранять конфигурацию системы при выходе".
void setSavePeriod( int vl ); — Установка периодичности автоматического сохранения станции в БД (секунд).
bool chkSelDB( const string& wDB ); — Функция проверки на соответствие указанной БД wDB выбранной в "selDB()".
string optDescr( ); — Локализованная помощь по опциям командной строки и параметрам конфигурационного файла.
static void sighandler( int signal ); — Функция стандартного обработчика сигналов системы в целом.
unsigned long long sysClk( ); — Расчётная частота процессора на котором функционирует система (Гц).
void clkCalc( ); — Расчёт частоты процессора на котором работает система. Вызывается периодически для систем с переменной частотой процессора.
unsigned long long shrtCnt( ); — Функция замера малых интервалов времени по счетчику тактов процессора. Возвращает значение счетчика тактов процессора.
static long HZ( ); — Время системного тика процессора.
void taskCreate( const string &path, int priority, void *(*start_routine)(void *), void *arg, int wtm = 5, pthread_attr_t *pAttr = NULL, bool *startSt = NULL ); — Создание задачи (потока) с идентификатором path, приоритетом priority (-1...99), функцией задачи start_routine и её аргументов arg, а так-же ожиданием запуска пользовательской процедуры по признаку startSt.
void taskDestroy( const string &path, bool *endrunCntr = NULL, int wtm = 5, bool noSignal = false ); — Удаление задачи с идентификатором path и командой останова endrunCntr. Используйте noSignal для предотвращения отправки задаче сигнала SIGALRM.
double taskUtilizTm( const string &path, bool max = false ); — Время, в секундах, утилизации ресурсов процессора задачей path, или его максимальное значение max.
static bool taskEndRun( ); — Проверка на команду окончания задачи, посредством сигнала SIGUSR1.
static const STask& taskDescr( ); — Получение ссылки на описатель текущей задачи.
static int sysSleep( float tm ); — Функция системного засыпания потока на время в секундах, вплоть до наносекунд (1e-9).
time_t sysTm( ); — Системное время быстрого доступа, из обновляемой ячейки.
static int64_t curTime(); — Текущее время в микросекундах с начала эпохи (01.01.1970).
string prjUserDir( ); — Директория проектов пользователя.
bool prjCustMode( ); — Специальный режим проектов.
void setPrjCustMode( bool vl ); — Установка специального режима проектов.
string prjNm( ); — Имя проекта конфигурации.
void setPrjNm( const string &vl ); — Установка имени проекта конфигурации.
bool prjSwitch( const string &prj, bool toCreate = false ); — Переключение на проект prj.
int prjLockUpdPer( ); — Получение периода обновления замка проекта, нуль для отключения замка.
bool prjLock( const char *cmd ); — Обработка замка проекта для команды cmd ("hold", "free", "update").
static void taskSleep( int64_t per, const string &cron = "", int64_t *lag = NULL ); — Функция засыпания потока по сетке абсолютного времени с периодом per в наносекундах или до запланированного времени cron. Если указано запаздывание lag то в него будет возвращена разница между реальным и запланированным пробуждением (потеря циклов).
static time_t cron( const string &vl, time_t base = 0 ); — Планирование времени исполнения по формату стандарта Cron vl, начиная от базового времени base или от текущего времени, если база не указана.
static bool eventWait( bool &m_mess_r_stat, bool exempl, const string &loc, time_t time = 0 ); — Функция ожидания события exempl для переменной m_mess_r_stat в течение указанного интервала времени time для источника loc.
bool cntrEmpty( ); — Проверка на отсутствие счётчиков отладки.
double cntrGet( const string &id ); — Получение счётчика отладки id.
void cntrSet( const string &id, double vl ); — Установка счетчика отладки id в значение vl.
void cntrIter( const string &id, double vl ); — Итерация счётчика отладки id на значение vl.
bool rdEnable( ); — Резервирование включено, присутствует хотя-бы одна резервная станция.
bool rdActive( ); — Резервирование активно, присутствует хотя-бы одна активная резервная станция.
void rdStList( vector<string> &ls ); — Список ls станций в резерве.
SStat rdSt( const string &id ); — Получение копии структуры состояния резервной станции id.
map<string, SStat> rdSts( ); — Получение копии списка структур состояний резервных станций.
int rdStLevel( ); — Уровень текущей станции в системе резервирования.
void setRdStLevel( int vl ); — Установка уровня текущей станции в системе резервирования.
float rdTaskPer( ); — Периодичность исполнения задачи резервирования.
void setRdTaskPer( float vl ); — Установка периодичности исполнения задачи резервирования.
int rdRestConnTm( ); — Время повторения попытки восстановления связи с резервными станциями после её потери, в секундах.
void setRdRestConnTm( int vl ); — Установка времени повторения попытки восстановления связи с резервными станциями.
string rdStRequest( XMLNode &req, const string &st = "" ); — Общий запрос req к указанной резервной станции st.
static string int2str( int val, IntView view = Dec ); — Преобразование целого знакового в строку вида view.
static string uint2str( unsigned val, IntView view = Dec ); — Преобразования целого беззнакового в строку вида view.
static string ll2str( long long val, IntView view = Dec ); — Преобразования длинного целого (64бит) в строку вида view.
static string real2str( double val, int prec = 15, char tp = 'g' ); — Преобразования вещественного с точностью prec знаков и типом tp в строку.
static double realRound( double val, int dig = 0, bool toint = false ); — Округление вещественного числа до указанного знака dig после запятой с возможностью преобразования к целому после округления toint.
static string atime2str( time_t tm, const string &format = "" ); — Преобразование астрономичного UNIX времени tm в строку, в соответствии с форматом format POSIX-функции "strftime()".
static string time2str( double tm ); — Преобразование интервала времени, в секундах, в строку вида "1час 23мин 10сек".
static string cpct2str( double cnt ); — Преобразование счётчика трафика cnt (байт) в строки вида "12.5КиБ".
static double str2real( const string &val ); — Преобразование строки в вещественное.
static string addr2str( void *addr ); — Преобразование адреса в строку.
static void *str2addr( const string &str ); — Преобразование строки в адрес.
static string strTrim( const string &val, const string &cfg = " \n\t\r" ); — Удаляет из исходной строки val указанные cfg (в основном пустые) символы в начале и в конце.
static string strSepParse( const string &path, int level, char sep, int *off = NULL ); — Разбор строки path на составляющие, отделённые разделительным символом sep, начиная со смещения off и контролируя смещение конца элемента в нём же.
static string strParse( const string &str, int level, const string &sep, int *off = NULL, bool mergeSepSymb = false ); — Расширенная версия функции разбора строки "strSepParse()" позволяющая использовать многосимвольные разделители и объединять односимвольные.
static string strLine( const string &str, int level, int *off = NULL ); — Разбор текста по строкам для разных способов окончания строки (CR, LF и CR/LF).
static string pathLev( const string &path, int level, bool decode = true, int *off = NULL ); — Выделение элементов пути path с возможностью их декодирования, начиная со смещения off и контролируя смещение конца элемента в нём же.
static string path2sepstr( const string &path, char sep = '.' ); — Преобразование пути в строку с разделителем sep элементов.
static string sepstr2path( const string &str, char sep = '.' ); — Преобразование строки с разделителем sep элементов в путь.
static string strEncode( const string &in, Code tp, const string &opt1 = "" ); — Кодирование строки по указанному правилу tp и опцией opt1 (символы для "Custom").
static string strDecode( const string &in, Code tp = Custom, const string &opt1 = "" ); — Декодирование строки in по указанному правилу tp и опцией opt1 (разделитель или "<text>" для "Bin").
static string strMess( const char *fmt, ... ); static string strMess( unsigned len, const char *fmt, ... ); — Формирование стоки по шаблону fmt и аргументам. Реализован на основе "printf". Для варианта ограничения длины превышение отмечается добавлением "...".
static string strLabEnum( const string &base ); — Формирование индивидуальных строковых меток от базы base путём инкрементации в конце. Поддерживается нумерация в десятичном, шестнадцатеричном (префикс "0x") и восьмеричном (префикс "0") представлении.
string strCompr( const string &in, int lev = -1 ); — Компрессия строки in с уровнем компрессии lev.
string strUncompr( const string &in ); — Декомпрессия строки in.
static inline uint16_t getUnalign16( const void *p ); static inline uint32_t getUnalign32( const void *p ); static inline uint64_t getUnalign64( const void *p ); — Невыравненное чтение беззнакового целого из буфера по смещению.
static inline int getUnalignInt( const void *p ); — Невыравненное чтение знакового целого из буфера по смещению.
static inline float getUnalignFloat( const void *p ); — Невыравненное чтение вещественного "float" из буфера по смещению.
static inline double getUnalignDbl( const void *p ); — Невыравненное чтение вещественного "double" из буфера по смещению.
static uint16_t i16_LE( uint16_t in ); static uint32_t i32_LE( uint32_t in ); static uint64_t i64_LE( uint64_t in ); — Преобразование порядка целого числа in из формата Little-Endian (LE) во внутреннее представление.
static uint16_t i16_BE( uint16_t in ); static uint32_t i32_BE( uint32_t in ); static uint64_t i64_BE( uint64_t in ); — Преобразование порядка целого числа in из формата Big-Endian (BE) во внутреннее представление.
static float floatLE( float in ); static double doubleLE( double in ); — Преобразование вещественного числа in из внутреннего представления в формат IEEE754 Little-Endian (LE).
static float floatLErev( float in ); static double doubleLErev( double in ); — Преобразование вещественного числа in из формата IEEE754 Little-Endian (LE) во внутреннее представление.
static float floatBE( float in ); static double doubleBE( double in ); — Преобразование вещественного числа in из внутреннего представления в формат IEEE754 Big-Endian (BE).
static float floatBErev( float in ); static double doubleBErev( double in ); — Преобразование вещественного числа in из формата IEEE754 Big-Endian (BE) во внутреннее представление.
string getCmdOpt( int &curPos, string *argVal = NULL ); static string getCmdOpt_( int &curPos, string *argVal, int argc, char **argv ); — Разбор параметров командной строки с перебором по курсору curPos. Возвращает имя аргумента и его возможное значение в argVal. Реализует форматы коротких ключей: "-v", "-v val", "-abcv", "-abcv val"; и длинных ключей: "--var", "--var=val", "--var val".
bool cmdOptPresent( const string &opt ); — Проверить параметр командной строки opt на присутствие.
string cmdOpt( const string &opt, const string &setVl = "" ); — Получения параметра opt командной строки. Установка в setVl, если указан.
static void ctrListFS( XMLNode *nd, const string &fsBase, const string &fileExt = "" ); — Список обзора элементов файловой системы относительно базы fsBase, для файлов c расширениями fileExt в виде списка "png;jpeg;gif;".
ResRW &cfgRes( ); — Локатор ресурса дерева конфигурационного файла.

Публичные атрибуты:

static bool finalKill — Признак "Финальное разрушение объектов". Используется для принудительного отключения заблокированных объектов на финальной стадии выключения.

Короткие вызовы глобальных функций в области имён "OSCADA":

template <class fVal> fVal fmin( fVal a, fVal b ); template <class fVal> fVal fmax( fVal a, fVal b ); — функциональные шаблоны определения минимума и максимума двух значений.
inline string i2s( int val, TSYS::IntView view = TSYS::Dec ) —> TSYS::int2str(val, view);
inline string u2s( unsigned val, TSYS::IntView view = TSYS::Dec ) —> TSYS::uint2str(val, view);
inline string ll2s( long long val, TSYS::IntView view = TSYS::Dec ) —> TSYS::ll2str(val, view);
inline string r2s( double val, int prec = 15, char tp = 'g' ) —> TSYS::real2str(val, prec, tp);
inline double rRnd( double val, int dig = 0, bool toint = false ) —> TSYS::realRound(val, dig, toint);
inline string atm2s( time_t tm, const string &format = "" ) —> TSYS::atime2str(tm, format);
inline string tm2s( double tm ) —> TSYS::time2str(tm);
inline int s2i( const string &val ) —> atoi(val.c_str());
inline long long s2ll( const string &val ) —> atoll(val.c_str());
inline double s2r( const string &val ) — TSYS::str2real(val);
inline string sTrm( const string &val, const string &cfg = " \n\t\r") —> TSYS::strTrim(val, cfg);

2.2. Объект сообщений системы (TMess)

Данные:
Типы (уровни) сообщений (enum — TMess::Type):

Debug (0) — отладка;
Info (1) — информация;
Notice (2) — замечание;
Warning (3) — предупреждение;
Error (4) — ошибка;
Crit (5) — критическая ситуация;
Alert (6) — тревога;
Emerg (7) — авария.

Направления сообщений (enum — TMess::Direct):

DIR_SYSLOG (0x1) — в SYSLOG;
DIR_STDOUT (0x2) — на стандартный выход;
DIR_STDERR (0x4) — на выход стандартных ошибок;
DIR_ARCHIVE (0x8) — в архив сообщений.

Структура сообщения (class — TMess::SRec):

time_t time; — время сообщения;
int utime; — микросекунды времени сообщения;
string categ; — категория сообщения (обычно путь внутри системы);
int8_t level; — уровень сообщения;
string mess; — сообщение.

Шаблоны:

_(mess) — Обёртка над функцией трансляции сообщений для предоставления принятого во многих программах вызова перевода сообщений.
trL(base,lng); trU(base,usr); trLU(base,lng,usr) — Обёртки над функциями динамической трансляции текстовых переменных по языку и пользователю.
trSetL(base,lng,mess); trSetU(base,usr,mess); trSetLU(base,lng,usr,mess) — Обёртки над функциями установки динамической трансляции текстовых переменных по языку и пользователю.
FTM(rec); FTM2(tm, utm) — Получения полного времени сообщения в микросекундах, используя два поля времени структуры сообщения.
mess_lev() — Уровень сообщений системы. Часто используется для для проверки режима отладки (=Debug).
message(cat,lev,fmt,args...) — Формирование полного сообщения.
mess_debug(cat,fmt,args...) — Формирование отладочного сообщения.
mess_info(cat,fmt,args...) — Формирование информационного сообщения.
mess_note(cat,fmt,args...) — Формирования сообщения - замечания.
mess_warning(cat,fmt,args...) — Формирование предупредительного сообщения.
mess_err(cat,fmt,args...) — Формирование сообщения ошибки.
mess_crit(cat,fmt,args...) — Формирование сообщения критического состояния.
mess_alert(cat,fmt,args...) — Формирование сообщения тревоги.
mess_emerg(cat,fmt,args...) — Формирование сообщения аварии.
message_(cat,lev,fmt,args...) — Формирование полного сообщения (игнорируется выбранный уровень и категории отладки).
mess_debug_(cat,fmt,args...) — Формирование отладочного сообщения (игнорируется выбранный уровень и категории отладки).
mess_info_(cat,fmt,args...) — Формирование информационного сообщения (игнорируется выбранный уровень).
mess_note_(cat,fmt,args...) — Формирования сообщения - замечания (игнорируется выбранный уровень).
mess_warning_(cat,fmt,args...) — Формирование предупредительного сообщения (игнорируется выбранный уровень).
mess_err_(cat,fmt,args...) — Формирование сообщения ошибки (игнорируется выбранный уровень).
mess_crit_(cat,fmt,args...) — Формирование сообщения критического состояния (игнорируется выбранный уровень).
mess_alert_(cat,fmt,args...) — Формирование сообщения тревоги (игнорируется выбранный уровень).
mess_emerg_(cat,fmt,args...) — Формирование сообщения аварии (игнорируется выбранный уровень).

Публичные методы:

void load( ); — Загрузка.
void save( ); — Сохранение.
string codeConv( const string &fromCH, const string &toCH, const string &mess); — Конвертация кодировки сообщения.
string codeConvIn( const string &fromCH, const string &mess); — Конвертация кодировки сообщения во внутреннюю кодировку системы.
string codeConvOut( const string &toCH, const string &mess); — Конвертация кодировки сообщения из внутренней кодировки системы.
const char *I18N( const char *mess, const char *d_name = NULL, const char *mLang = NULL ); — Получение сообщения на языке mLang или языке системы если указанный NULL или пуст или для не режима динамического перевода сообщений.
string I18Ns( const string &mess, const char *d_name = NULL, const char *mLang = NULL ); — Получение сообщения на языке mLang или языке системы если указанный NULL или пуст или для не режима динамического перевода сообщений.
string lang( ); — Язык системы, в виде en_US.UTF-8.
string lang2Code( ); — Язык системы в двухсимвольной кодировке (en).
string &charset( ); — Системная кодировка.
int logDirect( ); — Приемники, которым направляются системные сообщения (stdout, stderr, syslog, archive);
int messLevel( ); — Уровень, ниже которого сообщения игнорируются.
string selDebCats( ); — Выбранные категории отладки (списком с разделителем ';').
bool isUTF8( ); — Внутренняя кодировка UTF-8.
void setLang( const string &lang, bool init = false ); — Установка языка системы (локализации).
void setLogDirect( int dir ); — Установка приемников которым направляются системные сообщения. Для dir используется битовая маска. Где:
1 – в syslog;
2 – в stdout;
4 – в stderr;
8 – в архив.
void setMessLevel( int level ); — Установка минимального уровня обрабатываемых сообщений.
void setSelDebCats( const string &vl ); — Установка категорий отладки (списком с разделителем ';').
void put( const char *categ, int8_t level, const char *fmt, ... ); — Формирование сообщения за текущее время с категорией categ, уровнем level форматированным сообщение fmt и следующими аргументами.
void put_( const char *categ, int8_t level, const char *fmt, ... ); void putArg( const char *categ, int8_t level, const char *fmt, va_list ap ); — Формирование сообщения за текущее время (игнорируется выбранный уровень и категории отладки) с категорией categ, уровнем level форматированным сообщение fmt и следующими аргументами.
void get( time_t b_tm, time_t e_tm, vector<TMess::SRec> &recs, const string &category = "", int8_t level = Debug ); — Запросить сообщения из архива за промежуток времени b_tm — e_tm в соответствии с шаблоном категории category и минимальным уровнем level.
string lang2CodeBase( ); — Язык базовых сообщений текстовых переменных в двухсимвольной кодировке (en).
bool translDyn( bool plan = false ); — Режим "Динамический перевод" или его план plan на следующий запуск.
bool translEnMan( ); — Признак "Включен менеджер переводов", для активации индекса встроенных сообщений перевода и менеджера перевода.
string translLangs( ); — Список языков перевода, в менеджере.
string translFld( const string &lng, const string &fld, bool isCfg = false ); — Представление наименования поля с переводом с именем fld и языком lng для конфигурации isCfg или БД.
void setLang2CodeBase( const string &vl ); — Установка языка базовых сообщений текстовых переменных в двухсимвольной кодировке (en).
void setTranslDyn( bool val, bool plan = true ); — Установка режима "Динамический перевод" или его плана plan в значение val на следующий запуск.
void setTranslEnMan( bool vl, bool passive = false ); — Установка "Включен менеджер переводов" в значение vl и пассивном режиме passive.
void setTranslLangs( const string &vl ); — Установка списка языков перевода.
string translGet( const string &base, const string &lang, const string &src = "" ); string translGetU( const string &base, const string &user, const string &src = "" ); string translGetLU( const string &base, const string &lang, const string &user, const string &src = "" ); — Получение перевода базовой текстовой переменной base для языка lang или пользователя user и опционального источника src.
string translSet( const string &base, const string &lang, const string &mess, bool *needReload = NULL ); string translSetU( const string &base, const string &user, const string &mess, bool *needReload = NULL ); string translSetLU( const string &base, const string &lang, const string &user, const string &mess, bool *needReload = NULL ); — Установка перевода базовой текстовой переменной base для языка lang или пользователя user и опционального источника src в значение mess.
void translReg( const string &mess, const string &src, const string &prms = "" ); — Регистрация переводимого сообщения mess с источником src и вспомогательными параметрами prms в индексе переводов.
static const char *labDB( ); static const char *labSecCRON( ); static const char *labSecCRONsel( ); static const char *labTaskPrior( ); — Общие метки помощи.
int getUTF8( const string &str, int off = 0, int32_t *symb = NULL ); — Получение и разбор символа UTF-8.

2.3. Объект подсистемы (TSubSYS)

Наследует:	TCntrNode.
Наследуется:	TArchiveS, TProtocolS, TBDS, TFunctionS, TSeсurity, TModShedul, TTransportS, TUIS, TSpecialS, TControllerS.

Публичные методы:

TSubSYS( const char *id, const char *name, bool mod = false ); — Инициализирующий конструктор. Признак mod указывает, что подсистема модульная.
string subId( ); — Идентификатор подсистемы.
string subName( ); — Локализованное имя подсистемы.
bool subStartStat( ) const; — Признак исполнения подсистемы.
bool subModule( ) const; — Признак модульности подсистемы.
virtual int subVer( ); — Версия подсистемы.
virtual void subStart( ); — Запуск подсистемы.
virtual void subStop( ); — Останов подсистемы.
void modList( vector<string> &list ); — Список list модулей модульной подсистемы.
bool modPresent( const string &name ); — Проверка на наличие указанного модуля name.
void modAdd( TModule *modul ); — Добавление/регистрация модуля modul.
void modDel( const string &name ); — Удаление модуля name.
AutoHD<TModule> modAt( const string &name ) const; — Подключение к модулю name.
virtual void perSYSCall( unsigned int cnt ); — Периодичный вызов из системного потока, с периодичностью 10 секунд и секундным счётчиком cnt.
virtual bool rdProcess( XMLNode *reqSt = NULL ); — Обработка резервирования подсистемы, вызывается из системной задачи резервирования. В reqSt передаётся результат запроса состояния резервной станции по данной подсистеме.
TSYS &owner( ) const; — Система - владелец подсистемы.

2.4. Объект модуля (TModule)

Наследует:	TCntrNode.
Наследуется:	TProtocol, TTypeBD, TTypeArchive, TTypeTransport, TUI, Tspecial, TTypeDAQ.

Данные:
Структура данных идентифицирующая модуль (class — TModule::SAt):

SAt( const string &iid, const string &itype = "", int itver = 0 ); — инициализирующий конструктор;
bool operator==( const TModule::SAt &amst ) const; — функция сравнения идентификаторов модулей;
string id; — идентификатор модуля;
string type; — тип модуля (подсистема);
int tVer; — версия типа модуля (подсистемы) для которой модуль разработан.

Структура экспортируемых функций (class — TModule::ExpFunc):

string prot; — прототип функции;
string dscr; — локализованное описание функции;
void (TModule::*ptr)(); — относительный адрес функции (относительно объекта модуля).

Публичные методы:

TModule( const string &id ); — Инициализирующий конструктор модуля id.
string modId( ); — Идентификатор модуля.
string modName( ); — Локализованное имя модуля.
virtual void modStart( ); — Запуск модуля.
virtual void modStop( ); — Останов модуля.
virtual void modInfo( vector<string> &list ); — Список list информационных элементов модуля.
virtual string modInfo( const string &name ); — Получение содержимого указанного информационного элемента name. Для получения элемента на другом языке, при динамическом переводе сообщений, Вы можете установить имя в виде "{Имя}:{язык}".
virtual void perSYSCall( unsigned int cnt ); — Периодичный вызов из системного потока, с периодичностью 10 секунд и секундным счётчиком cnt.
void modFuncList( vector<string> &list ); — Список list экспортируемых функций модуля.
bool modFuncPresent( const string &prot ); — Проверка на наличие указанной функции по её прототипу prot.
ExpFunc &modFunc( const string &prot ); — Получить информацию об экспортируемой функции модуля prot.
bool modFunc( const string &prot, void (TModule::**offptr)(), bool noex = false ); — Получение относительного адреса offptr экспортируемой функции prot. Возвращает "true" в случае успеха и режима без исключений noex.
const char *I18N( const char *mess ); — Локализация модульного сообщения mess в соответствии с текущей локалью.
TSubSYS &owner( ) const; — Подсистема - владелец модуля.

Защищённые атрибуты:

string mModName; — Имя модуля.
string mModDescr; — Описание модуля.
string mModType; — Тип модуля.
string mModVers; — Версия модуля.
string mModAutor; — Автор модуля.
string mModLicense; — Лицензия модуля.
string mModSource; — Источник/происхождение модуля.

Защищённые методы:

void modInfoMainSet( const string &name, const string &type, const string &vers, const string &author, const string &descr, const string &license, const string &source ); — Установка общей информации модуля.
void modFuncReg( ExpFunc *func ); — Регистрация экспортируемых модулем функций.

3. Подсистема "Базы Данных" (TBDS)

Подсистема "Базы Данных" представлена объектом TBDS, который содержит модульные объекты типов БД TTypeBD. Каждый тип базы данных содержит объекты отдельно взятых баз данных данного типа TBD. Каждая БД, в свою очередь, содержит объекты своих таблиц TTable (рис. 3).

Иерархическая структура подсистемы БД (28 Кб)

Рис. 3. Иерархическая структура подсистемы БД.

Подсистема представляет базовые функции для доступа к типам БД, а также обобщающие функции для манипуляции с базами данных и таблицами. Так, для сокрытия источника данных, которым может быть и конфигурационный файл, предоставляются функции абстрактного доступа к источнику данных. А для хранения общесистемных данных предоставляется системная таблица и функции абстрактного доступа к ней. Следовательно, общесистемные данные могут храниться как в конфигурационном файле, так и в таблице БД. Приоритетным источником в таком случае является таблица БД.

Являясь модульным объектом, тип БД (TTypeBD) содержит доступ к реализации механизма той или иной БД. Доступ производится посредством открытых БД модуля отдельно взятого типа БД. Открываемые/регистрируемые БД описываются в таблице открываемых БД или в конфигурационном файле. Существует так называемая рабочая БД, которая открывается всегда и указывается в конфигурационном файле. БД, поддерживающие SQL-запросы, могут предоставлять доступ, основанный на прямых SQL-запросах.

В процессе использования компоненты системы OpenSCADA открывают таблицы (TTable) в доступных БД и работают с ними.

3.1. Объект подсистемы "Базы Данных" (TBDS)

Наследует:

TSubSYS, TElem.

Данные:
Флаги запросов к системной таблице (enum – TDBS::ReqGen):

OnlyCfg — запрос только к конфигурационному файлу.
UseTranslate — использовать перевод текстовой переменной.

Публичные методы:

int subVer( ); — Версия подсистемы.
static string realDBName( const string &bdn ); — Преобразование полного шаблонного имени БД или таблицы (вида *.*.myTbl) в реальное имя. Фактически выполняется замена специальных элементов '*' на элементы рабочей БД.
void dbList( vector<string> &ls, bool checkSel = false ); — Список доступных БД. checkSel указывает на необходимость проверки факта загрузки из выбранной БД и вставки в список БД только выбранной.
AutoHD<TTable> open( const string &bdn, bool create = false ); — Открытие таблицы bdn БД по её полному пути с созданием create в случае отсутствия.
void close( const string &bdn, bool del = false ); — Закрытие таблицы bdn БД по её полному пути с возможностью удаления после закрытия del.
bool dataSeek( const string &bdn, const string &path, int lev, TConfig &cfg, bool forceCfg = false, vector< vector<string> > *full = NULL ); — Общее сканирование записей источника данных. В качестве источника выступает конфигурационный файл или БД. В случае отсутствия БД используется конфигурационный файл. Если имя БД bdn или путь path конфигурационного файла не указаны, то их обработка пропускается. full определяется перед запросом для предзагрузки результата целиком и значительного ускорения.
bool dataGet( const string &bdn, const string &path, TConfig &cfg, bool forceCfg = false, bool noEx = false ); — Получение записи из источника данных (БД или конфигурационный файл). Если имя БД bdn или путь path конфигурационного файла не указаны, то их обработка пропускается.
void dataSet( const string &bdn, const string &path, TConfig &cfg, bool forceCfg = false, bool noEx = false ); — Установить/сохранить запись в источнике данных (БД или конфигурационный файл). Если имя БД bdn или путь path конфигурационного файла не указаны, то их обработка пропускается.
bool dataDel( const string &bdn, const string &path, TConfig &cfg, bool useKeyAll = false, bool forceCfg = false, bool noEx = false ); — Удаление записи из источника данных (БД или конфигурационный файл). Если имя БД bdn или путь path конфигурационного файла не указаны, то их обработка пропускается. useKeyAll используется для указания необходимости установки всех ключей для использования их при удалении с восстановлением исходного состояний выбора ключей при выходе из функции. Если этот флаг не установлен, то используются ранее выбранные ключи для выполнения операции.
static string genDBGet( const string &path, const string &oval = "", const string &user = "root", char rFlg = 0 ); — Получить общесистемные данные из конфигурационного файла или системной таблицы от имени пользователя user. Если данные отсутствуют, то возвращается значений oval.
static void genDBSet( const string &path, const string &val, const string &user = "root", char rFlg = 0 ); — Установить/сохранить обще-системные данные в конфигурационном файле или системной таблице от имени пользователя user.
string fullDBSYS( ); — Полное имя системной таблицы.
string fullDB( ); — Полное имя таблицы с описанием зарегистрированных БД.
TElem &openDB_E( ) — Структура таблицы зарегистрированных БД.
AutoHD<TTypeBD> at( const string &iid ) — Обращение к модулю БД (типу БД).
string optDescr( ); — Локализованная помощь по опциям командной строки и параметрам конфигурационного файла.

3.2. Модульный объект типов баз данных (TTypeBD)

Наследует:	TModule.
Наследуется:	Корневыми объектами модулей подсистемы "БД".

Публичные методы:

bool fullDeleteDB( ); — Признак полного удаления БД.
void list( vector<string> &list ) const; — Список зарегистрированных (открытых) БД.
bool openStat( const string &idb ) const; — Проверка на наличие указанной открытой БД.
void open( const string &iid ); — Открытие БД.
void close( const string &iid, bool erase = false ); — Закрытие БД. Если установлен признак erase, то БД будет полностью удалена.
AutoHD<TBD> at( const string &name ) const; — Подключение к открытой БД.
TBDS &owner( ) const; — Подсистема - владелец модуля.

3.3. Объект базы данных (TBD)

Наследует:	TCntrNode, TConfig.
Наследуется:	Объектами баз данных модулей подсистемы "БД".

Публичные методы:

TBD( const string &iid, TElem *cf_el ); — Инициализирующий конструктор.
string id( ); — Идентификатор БД.
string fullDBName( ); — Полное имя хранилища-БД.
string name( ); — Имя БД.
string dscr( ); — Описание БД.
string addr( ) const; — Адрес БД. Форма записи отлична для каждого типа БД.
string codePage( ); — Кодовая страница, в которой хранятся данные БД.
bool enableStat( ) const; — Состояние БД: "Включена".
bool toEnable( ); — Признак БД: "Включать".
void setName( const string &inm ); — Установка имени БД.
void setDscr( const string &idscr ); — Установка описания БД.
void setAddr( const string &iaddr ); — Установка адреса БД.
void setCodePage( const string &icp ); — Установка кодовой страницы хранения данных в БД.
void setToEnable( bool ivl ); — Установка признака: "Включать".
virtual void enable( ); — Включение БД.
virtual void disable( ); — Отключение БД.
virtual void allowList( vector<string> &list ) const; — Список таблиц, содержащихся в данной БД.
void list( vector<string> &list ) const; — Список открытых таблиц.
bool openStat( const string &table ) const; — Признак указывающий на то, что запрошенная таблица открыта.
void open( const string &table, bool create ); — Открытие таблицы. Если установлен признак create, то в случае отсутствия таблица будет создана.
void close( const string &table, bool del = false, long tm = -1 ); — Закрытие таблицы. Если установлен признак del, то таблица будет полностью удалена.
AutoHD<TTable> at( const string &name ) const; — Подключение к таблице.
virtual void sqlReq( const string &req, vector< vector<string> > *tbl = NULL, char intoTrans = EVAL_BOOL ); — Отправка SQL-запроса req на БД и получение результата в виде таблицы tbl. При установке intoTrans в true для запроса будет открыта транзакция, в false будет закрыта.
virtual void transCloseCheck( ) — Периодически вызываемая функция для проверки транзакций и закрытия старых или содержащих много запросов.
TTypeBD &owner( ) const; — Тип базы данных – владелец данной БД.

Защищённые методы:

virtual TTable *openTable( const string &table, bool create ); — Модульный метод открытия таблицы.

3.4. Объект таблицы (TTable)

Наследует:	TCntrNode.
Наследуется:	Объектами таблиц модулей подсистемы "БД".

Публичные методы:

TTable( const string &name ); — Инициализирующий конструктор.
string name( ); — Имя таблицы.
string fullDBName( ); — Полное имя хранилища-таблицы в БД.
virtual void fieldStruct( TConfig &cfg ); — Получение структуры таблицы.
virtual bool fieldSeek( int row, TConfig &cfg, vector< vector<string> > *full = NULL ); — Сканирование записей cfg таблицы по row, где full определяется перед запросом для предзагрузки результата целиком и значительного ускорения.
virtual void fieldGet( TConfig &cfg ); — Запрос указанной записи. Запрашиваемая запись определяется значениями ключевых ячеек исходной записи cfg.
virtual void fieldSet( TConfig &cfg ); — Установка значений указанной записи. В случае отсутствия запись будет создана.
virtual void fieldDel( TConfig &cfg ); — Удаление указанной записи.
TBD &owner( ) const; — БД – владелец данной таблицы.

4. Подсистема "Сбор данных" (TDAQS)

Подсистема "Сбор данных" представлена объектом TDAQS, который содержит модульные объекты типов источников данных TTypeDAQ и объекты библиотек шаблонов параметров подсистемы "Сбор данных" TPrmTmplLib. Объект типов источников данных содержит объекты контроллеров TController и объекты типов параметров TTypeParam. Объекты типов параметров предоставляются модулем контроллера и содержат структуру БД отдельных типов параметров (аналоговые, дискретные ...). Объекты контроллеров содержат объекты параметров TParamContr. Каждый параметр ассоциируется с одним из типов параметров. Для хранения атрибутов параметр наследуется от объекта значений TValue, который и содержит значения атрибутов TVal. Библиотека шаблонов параметров данной подсистемы содержит объекты шаблонов TPrmTmpl. Пример описанной иерархической структуры приведён на рис. 4.

Иерархическая структура подсистемы сбора данных (25 Кб)

Рис. 4. Иерархическая структура подсистемы сбора данных.

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

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

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

Некоторые реализации источников данных могут предоставлять возможность формирования структуры параметра по ранее разработанным шаблонам параметров. Для этой цели подсистема содержит библиотеки шаблонов, которые, в свою очередь, содержат шаблоны параметров. В примере изображена библиотека шаблонов "base" с шаблонами "digAlrm" и "smplBrd".

На уровне подсистемы предоставляются механизм резервирования источников данных. Резервирование подразумевает возможность согласованной работы нескольких станций OpenSCADA для выполнения общей задачи сбора данных в одноимённых источниках данных.

4.1. Объект подсистемы "Сбор данных" (TDAQS)

Наследует:

TSubSYS.

Публичные методы:

int subVer( ); — Версия подсистемы.
void subStart( ); — Запуск подсистемы.
void subStop( ); — Останов подсистемы.
AutoHD<TTypeDAQ> at( const string &name ) const; — Подключение к типу источника данных.
AutoHD<TValue> prmAt( const string &path, char sep = 0, bool noex = false ) const; — Подключение к параметру по пути path или строке с разделителем sep. Не генерировать исключения если установлен noex.
AutoHD<TVal> attrAt( const string &path, char sep = 0, bool noex = false ) const; — Подключение к атрибуту параметра по пути path или строке с разделителем sep. Не генерировать исключения если установлен noex.
void ctrListPrmAttr( XMLNode *nd, const string &addrBase, bool toPrm = false, char sep = 0, const string &pref = "" ); — Список обзора элементов атрибутов параметров или toPrm параметров DAQ с префиксом pref от пути или строке с разделителем sep базового адреса addrBase.
string tmplLibTable( ); — Имя таблицы для хранения шаблонов параметров подсистемы "Сбор данных".
void tmplLibList( vector<string> &list ) const; — Список доступных шаблонов параметров.
bool tmplLibPresent( const string &id ) const; — Проверка на наличие шаблона параметра id.
void tmplLibReg( TPrmTmplLib *lib ); — Регистрация шаблона параметра lib.
void tmplLibUnreg( const string &id, int flg = 0 ); — Удаление/снятие с регистрации шаблона параметра id.
AutoHD<TPrmTmplLib> tmplLibAt( const string &id ) const; — Подключение к шаблону параметра id.
float rdRestDtTm( ); — Максимальная глубина восстановления данных архивов при включении, в часах.
void setRdRestDtTm( float vl ); — Установка максимальной глубины восстановления данных архивов при включении.
void rdActCntrList( vector<string> &ls, bool isRun = false ); — Список активных контроллеров, работающих в схеме резервирования. При указании isRun в список попадут только исполняющиеся на данной станции контроллеры.
string rdStRequest( const string &cntr, XMLNode &req, const string &prevSt = "", bool toRun = true ); — Запрос req к резервной станции от имени контроллера cntr. Станция для запроса выбирается после указанной в prevSt, для исполняемого удалённо контроллера, при указании toRun.
TElem &elLib( ); — Структура таблицы библиотек шаблонов параметров.
TElem &elTmpl( ); — Структура таблицы шаблонов параметров.
TElem &elTmplIO( ); — Структура атрибутов шаблонов параметров.
TElem &elErr( ); — Структура атрибута(ов) ошибок параметров.

4.2. Модульный объект типа контроллера (TTypeDAQ)

Наследует:	TModule, TElem.
Наследуется:	Корневыми объектами модулей подсистемы "Сбор данных".

Публичные методы:

string DAQPath( ); — Получение DAQ адреса элемента.
void modStart( ); — Запуск модуля.
void modStop( ); — Останов модуля.
void list( vector<string> &list ) const; — Список контроллеров.
bool present( const string &name ) const; — Проверка на наличие указанного контроллера.
void add( const string &name, const string &daq_db = "*.*" ); — Добавить контроллер.
void del( const string &name ); — Удалить контроллер.
AutoHD<TController> at( const string &name, const string &who = "" ) const; — Подключиться к контроллеру.
bool tpPrmPresent( const string &name_t ); — Проверка на наличие указанного типа параметра.
unsigned tpPrmToId( const string &name_t ); — Получение индекса типа параметров по имени.
int tpParmAdd( const char *id, const char *n_db, const char *name ); — Добавление/регистрация типа параметров.
unsigned tpPrmSize( ); — Количество типов параметров.
TTypeParam &tpPrmAt( unsigned id ); — Получить объект типа параметров.
virtual bool compileFuncLangs( vector<string> *ls = NULL ); — Запрос перечня языков для которых реализована возможность формирования пользовательских процедур, в данном модуле, а также проверка факта их поддержки.
virtual void compileFuncSynthHighl( const string &lang, XMLNode &shgl ); — Запрос правил подсветки синтаксиса для указанного языка.
virtual string compileFunc( const string &lang, TFunction &fnc_cfg, const string &prog_text, const string &usings = "", int maxCalcTm = 0 ); — Компиляция/настройка пользовательской функции на поддерживаемом модулем языке программирования lang и исходном тексте процедуры prog_text, исходя из параметров процедуры fnc_cfg. Результатом является адрес к подготовленному объекту функции.
virtual bool redntAllow( ); — Признак поддержки механизмов резервирования модулем. Должен просто переопределяться и возвращать true.

Защищённые методы:

virtual TController *ContrAttach( const string &name, const string &daq_db ); — Подключение контроллера. Обязательно переопределяется в потомке модуля.

4.3. Объект контроллера (TController)

Наследует:	TCntrNode, TConfig.
Наследуется:	Объектами контроллеров модулей подсистемы "Сбор данных".

Данные:
Режимы резервирования (enum TController::Redundant):

Off (0) — выключено;
Asymmetric (1) — асимметричный;
OnlyAlarms (2) — только нарушения, подавление на резервном.

Командо-специфичное

Any (0) — любой режим.

Публичные методы:

TController( const string &name_c, const string &daq_db, TElem *cfgelem ); — Инициализирующий конструктор контроллера.
string DAQPath( ); — Получение DAQ адреса элемента.
string id( ); — Идентификатор контроллера.
string workId( ); — Рабочий идентификатор контроллера, включая идентификатор модуля.
string name( ); — Имя контроллера.
string descr( ); — Описание контроллера.
virtual string getStatus( ); — Функция запроса статуса контроллера.
string DB( ); — Имя БД экземпляра контроллера.
string tbl( ); — Имя таблицы базы данных экземпляра контроллера.
string fullDB( ); — Полное имя таблицы экземпляра контроллера.
void setName( const string &nm ); — Установить имя контроллера.
void setDescr( const string &dscr ); — Установить описание контроллера.
void setDB( const string &idb ); — Установка имени БД экземпляра контроллера.
bool toEnable( ); — Признак "Включать контроллер".
bool toStart( ); — Признак "Запускать контроллер".
bool enableStat( ) const; — Состояние "Включен".
bool startStat( ) const; — Состояние "Запущен".
int messLev( ); — Уровень сообщений диагностической информации.
void start( ); — Запуск контроллера.
void stop( ); — Останов контроллера.
void enable( ); — Включение контроллера.
void disable( ); — Отключение контроллера.
void list( vector<string> &list ) const; — Список параметров в контроллере.
bool present( const string &name ) const; — Проверка на наличие параметра name.
void add( const string &name, unsigned type ); — Добавление параметра name типа type.
void del( const string &name, bool full = false ); — Удаление параметра name. Если указано поле full то контроллер будет удалён полностью.
AutoHD<TParamContr> at( const string &name, const string &who = "th_contr" ) const; — Подключение к параметру контроллера name.
bool redntUse( Redundant md = Asymmetric ); — Состояния резервирования для режима md.
void setRedntUse( bool vl ); — Смена режима получения данных у резервной станции.
Redundant redntMode( ); — Режим резервирования ("<high>", "<low>", "<optimal>", {ForceStation}), включение.
void setRedntMode( Redundant vl ); — Установка режима резервирования, включение.
string redntRun( ); — Конфигурация предпочтительного исполнения.
void setRedntRun( const string &vl ); — Установка конфигурации предпочтительного исполнения.
virtual void redntDataUpdate( ); — Выполнение операции получения данных из резервной станции. Вызывается автоматически процедурой обслуживания схемы резервирования подсистемы.
virtual string catsPat( ); — список правил регулярного выражения разделённые '|' для выбора сообщений генерированных источником данных этого объекта по категориям.
void alarmSet( const string &mess, int lev = -TMess::Crit, const string &prm = "" ); — Формирование аварийной ситуации (нарушения) для объекта контроллера prm, или контроллера в целом если объект не указан, с сообщением mess и уровнем lev. Отрицательное значение уровня lev служит для установки, а положительное для снятия нарушения. Эта функция формирует нарушения и сообщения с категорией: al{ModId}:{CntrId}[.{PrmId}].
TTypeDAQ &owner( ) const; — Тип источника данных (модуль) - владелец данным контроллером.

Защищённые атрибуты:

bool en_st; — Признак "Включено".
bool run_st; — Признак "Запущено".

Защищённые методы:

virtual void enable_( ); — Включение контроллера. Перехватывается потомком.
virtual void disable_( ); — Отключение контроллера. Перехватывается потомком.
virtual void start_( ); — Запуск контроллера. Перехватывается потомком.
virtual void stop_( ); — Останов контроллера. Перехватывается потомком.
virtual TParamContr *ParamAttach( const string &name, int type ); — Модульный метод создания/открытия нового параметра.

4.4. Объект типа параметров (TTypeParam)

Наследует:

TElem.

Публичные методы:

TTypeParam( const char *iid, const char *iname, const char *idb = "", bool i_isPrmCntr = false ); — Инициализирующий конструктор.
virtual void create( TParamContr *prm ); — Создать или установить тип параметра prm.
virtual void destroy( TParamContr *prm ); — Удалить или снять тип параметра prm.
virtual string DB( TController *cntr ); — Получить имя таблицы параметров контроллера cntr.
void setDB( TController *cntr, const string &vl ); — Установить имя таблицы параметров контроллера cntr.
virtual void enable( TParamContr *prm ); — Включить параметр prm.
virtual void disable( TParamContr *prm ); — Отключить параметр prm.
virtual bool cfgChange( TParamContr *prm, TCfg &cfg ); — Модификация конфигурационного поля cfg параметра prm.
virtual void vlGet( TParamContr *prm, TVal &vo ); — Упреждающая функция получения значения, через параметр prm. Используется для прямого (синхронного) чтения.
virtual void vlSet( TParamContr *prm, TVal &vo, const TVariant &vl, const TVariant &pvl ); — Упреждающая функция установки значения, через параметр prm. Используется для прямой (синхронной) записи vl с предыдущим значением в pvl.
virtual void vlArchMake( TParamContr *prm, TVal &val ); — Уведомляющая функция о создании архива для атрибута val, через параметр prm. Используется для настройки созданного архива, в соответствии с особенностями источника данных.
virtual void getVals( TParamContr *prm ); — Функция внутренней реализация асинхронного режима, вызывается в цикле объекта контроллера для параметра prm.
virtual bool cntrCmdProc( TParamContr *prm, XMLNode *opt ); — Функция обслуживания запросов интерфейса управления, от параметра prm.

Публичные атрибуты:

string name; — Имя типа параметра.
string descr; — Описание типа параметра.
string db; — БД типа параметра.

4.5. Объект параметра физического уровня (TParamContr)

Наследует:	TConfig, TValue.
Наследуется:	Объектами параметров модулей подсистемы "Сбор данных".

Публичные методы:

TParamContr( const string &name, TTypeParam *tpprm ); — Инициализирующий конструктор.
string DAQPath( ); — Получение DAQ адреса элемента.
string ownerPath( bool inclSelf = false ); — Путь параметра-владельца, включая inclSelf данный параметр.
bool operator==( TParamContr & PrmCntr ); — Сравнение параметров.
string id( ); — Идентификатор параметра (шифр).
string name( ); — Имя параметра.
string descr( ); — Описание параметра.
bool toEnable( ); — Признак "Включать параметр".
bool enableStat( ) const; — Состояние "Включен".
void setName( const string &inm ); — Установка имени параметра.
void setDescr( const string &idsc ); — Установка описания параметра.
void setToEnable( bool vl ); — Установка признака "Включать параметр".
void list( vector<string> &list ) const; — Список параметров в данном параметре.
bool present( const string &name ) const; — Проверка на наличие параметра name.
void add( const string &name, unsigned type = 0 ); — Добавление параметра name типа type.
void del( const string &name, bool full = false ); — Удаление параметра name. Если указано поле full то контроллер будет удалён полностью.
AutoHD<TParamContr> at( const string &name, const string &who = "th_prm" ) const; — Подключение к параметру контроллера name.
TTypeParam &type( ) const; — Тип параметра.
virtual TElem *dynElCntr( ); — Контейнер динамических элементов атрибутов DAQ.
virtual void enable( ); — Включить параметр.
virtual void disable( ); — Отключить параметр.
TController &owner( ) const; — Контроллер – владелец параметра.

Защищённые методы:

virtual void setType( const string &tpId ); — вызывается для смены типа параметра tpId и может быть обработан в объекте модуля, для смены собственных данных.

4.6. Объект значения (TValue)

Наследует:	TCntrNode, TValElem.
Наследуется:	TParamContr.

Публичные методы:

bool dataActive( ); — Флаг активности (обновляемости) данных.
virtual string DAQPath( ); — Получение DAQ адреса элемента.
void vlList( vector<string> &list ) const; — Получение списка атрибутов.
bool vlPresent( const string &name ) const; — Проверка на наличия указанного атрибута.
AutoHD<TVal> vlAt( const string &name ) const; — Подключение к атрибуту.

Защищённые методы:

TConfig *vlCfg( ) — Получение связанного объекта конфигурации. Если возвращается NULL то отсутствует связанный объект конфигурации.
void setVlCfg( TConfig *cfg ); — Установка связанного объекта конфигурации cfg.
bool vlElemPresent( TElem *ValEl ); — Проверка на наличие элемента атрибутов ValEl.
void vlElemAtt( TElem *ValEl ); — Подключение структуры данных ValEl.
void vlElemDet( TElem *ValEl ); — Отключение структуры данных ValEl.
TElem &vlElem( const string &name ); — Получить структуру данных по её имени name.
virtual TVal* vlNew( ); — Создание экземпляра TVal. Может переопределяться в модулях для создания производных объектов атрибутов параметров подсистемы "Сбор данных".
virtual void vlGet( TVal &vo ); — Упреждающая функция получения значения. Используется для прямого (синхронного) чтения.
virtual void vlSet( TVal &vo, const TVariant &vl, const TVariant &pvl ); — Упреждающая функция установки значения. Используется для прямой (синхронной) записи vl с предыдущим значением в pvl.
virtual void vlArchMake( TVal &val ); — Уведомляющая функция о создании архива для атрибута val. Используется для настройки созданного архива, в соответствии с особенностями источника данных.

4.7. Объект атрибута (TVal).

Наследует:

TCntrNode.

Данные:
Дополнительные флаги к объекту TFld (enum TVal::AttrFlag):

TVal::DirRead(0x100) — флаг прямого чтения значения;
TVal::DirWrite(0x200) — флаг прямой записи значения;
TVal::Dynamic(0x400) — флаг динамического атрибута, обычно создаваемого из пользовательских процедур.

Публичные методы:

TVal( ); — Конструктор по умолчанию.
TVal( TFld &fld ); — Инициализация как хранилище динамических данных.
TVal( TCfg &cfg ); — Инициализация как отражение статических данных (БД).
string DAQPath( ); — Получение DAQ адреса элемента.
void setFld( TFld &fld ); — Инициализация как хранилище динамических данных.
void setCfg( TCfg &cfg ); — Инициализация как отражение статических данных (БД).
string name( ); — Имя атрибута.
int64_t time( ); — Метка времени последнего/текущего значения (10^-6с).
bool isCfg( ); — Признак объекта значения, созданного на основе элемента конфигурации.
bool dataActive( ); — Флаг активности (обновляемости) данных.
string getSEL( long long *tm = NULL, bool sys = false ); — Запрос значения выборочного типа на указанное время tm. Если NULL то возвратится последнее значение.
TVariant get( long long *tm = NULL, bool sys = false ); — Запрос значения на указанное время tm. Если NULL то возвратится последнее значение.
string getS( long long *tm = NULL, bool sys = false ); — Запрос значения строкового типа на указанное время tm. Если NULL то возвратится последнее значение.
double getR( long long *tm = NULL, bool sys = false ); — Запрос значения вещественного типа на указанное время tm. Если NULL то возвратится последнее значение.
int64_t getI( long long *tm = NULL, bool sys = false ); — Запрос значения целого типа на указанное время tm. Если NULL то возвратится последнее значение.
char getB( long long *tm = NULL, bool sys = false ); — Запрос значения логического типа на указанное время tm. Если NULL то возвратится последнее значение.
AutoHD<TVarObj> getO( int64_t *tm = NULL, bool sys = false ); — Запрос значения объектного типа.
void setSEL( const string &value, long long tm = 0, bool sys = false ); — Установка значения выборочного типа value.
void set( const TVariant &value, long long tm = 0, bool sys = false ); — Установка значения value.
void setS( const string &value, long long tm = 0, bool sys = false ); — Установка значения строкового типа value.
void setR( double value, long long tm = 0, bool sys = false ); — Установка значения вещественного типа value.
void setI( int64_t value, long long tm = 0, bool sys = false ); — Установка значения целого типа value.
void setB( char value, long long tm = 0, bool sys = false ); — Установка значения логического типа value.
void setO( AutoHD<TVarObj> value, int64_t tm = 0, bool sys = false ); — Установка значения объектного типа value.
AutoHD<TVArchive> arch( ); — Получение ассоциированного со значением архива.
void setArch( const AutoHD<TVArchive> &vl ); — Установка ассоциированного со значением архива.
string setArch( const string &nm = "" ); — Установка/создание нового архива с предложенным именем nm или автоматически, если имя пусто.
bool reqFlg( ); bool resB1( ); bool resB2( ) — Получить некоторые специфичные для реализации флаги.
void setReqFlg( bool vl ); void setResB1( bool vl ); void setResB2( bool vl ) — Установить некоторые специфичные для реализации флаги.
TFld &fld( ); — Описатель структуры атрибута.

4.8. Объект библиотеки шаблонов параметров подсистемы "DAQ" (TPrmTmplLib)

Наследует:

TCntrNode, TConfig.

Публичные методы:

TPrmTmplLib( const char *id, const char *name, const string &lib_db ); — Инициализирующий конструктор.
string id( ); — Идентификатор библиотеки.
string name( ); — Имя библиотеки.
string descr( ); — Описание библиотеки.
string DB( ); — БД экземпляра библиотеки.
string tbl( ); — Таблица БД экземпляра библиотеки.
string fullDB( ); — Полный адрес таблицы БД экземпляра библиотеки.
bool startStat( ) const; — Признак "Библиотека запущена".
void start( bool val ); — Запуск/останов библиотеки.
void setName( const string &vl ); — Установка имени библиотеки.
void setDescr( const string &vl ); — Установка описания библиотеки.
void setFullDB( const string &vl ); — Установка полного адреса таблицы БД экземпляра библиотеки.
void list( vector<string> &ls ) const; — Список шаблонов в библиотеке.
bool present( const string &id ) const; — Проверка на присутствие шаблона id в библиотеке.
AutoHD<TPrmTempl> at( const string &id ) const; — Подключение к шаблону id.
void add( const char *id, const char *name = "" ); — Добавление шаблона id.name в библиотеку.
void del( const char *id, bool full_del = false ); — Удаление шаблона id из библиотеки.
TDAQS &owner( ) const; — Объект - подсистема "DAQ", владелец библиотеки.

4.9. Объект шаблона параметров подсистемы "DAQ" (TPrmTempl)

Наследует:

TFunction, TConfig.

Данные:
Дополнительные флаги к объекту атрибута функции IO (enum TPrmTempl::IOTmplFlgs):

TPrmTempl::AttrRead(0x10) — атрибут только на чтение;
TPrmTempl::AttrFull(0x20) — атрибут с полным доступом;
TPrmTempl::CfgPublConst(0x40) — публичная постоянная;
TPrmTempl::CfgLink(0x80) — внешняя связь;
TPrmTempl::LockAttr(0x100) — заблокированный атрибут.

Публичные методы:

TPrmTempl( const char *id, const char *name = "" ); — Инициализирующий конструктор шаблона.
string id( ); — Идентификатор шаблона параметра.
string name( ); — Имя шаблона параметра.
string descr( ); — Описание шаблона параметра.
int maxCalcTm( ); — Лимит на максимальное время вычисления процедуры шаблона.
string progLang( ); — Язык программирования шаблона параметра.
bool progTr( ); — Перевод программы шаблона параметра.
string prog( ); — Программа шаблона параметра.
int64_t timeStamp( ); — Метка времени изменения объекта в БД.
void setName( const string &inm ); — Установка имени шаблона параметра.
void setDescr( const string &idsc ); — Установка описания шаблона параметра.
void setMaxCalcTm( int vl ); — Установка лимита на максимальное время вычисления процедуры шаблона.
void setProgLang( const string &ilng ); — Установка языка программирования шаблона параметра.
void setProgTr( bool vl ); — Установка перевода программы шаблона параметра.
void setProg( const string &iprg ); — Установка программы шаблона параметра.
void setStart( bool val ); — Пуск/останов шаблона параметра.
AutoHD<TFunction> func( ); — Подключение к функции, сформированной шаблоном.
TPrmTmplLib &owner( ) const; — Объект библиотеки шаблонов - владелец шаблона.

5. Подсистема "Архивы" (TArchiveS)

Подсистема "Архивы" представлена объектом TArchiveS, который содержит на уровне подсистемы модульные объекты типов архиваторов TTypeArchivator. Каждый объект типа архиватора содержит объекты архиваторов сообщений TMArchivator и архиваторов значений TVArchivator. Кроме этого объект подсистемы архивы содержит методы архива сообщений и объекты архивов значений TVArchive. Объект архива значений TVArchive содержит буфер значений путём наследования объекта буфера TValBuf. Для связи архива значений с архиваторами предназначен объект элемента значения TVArchEl. Этот объект содержится в архиваторе и на него ссылается архив. Структура подсистемы "Архивы" представлена на рис. 5.

Иерархическая структура подсистемы архивов (15 Кб)

Рис. 5. Иерархическая структура подсистемы архивов.

Подсистема "Архивы" содержит механизмы архивирования сообщений и значений. Непосредственно содержит архив сообщений вместе с его буфером. Содержит методы доступа к архивам значений и архиваторам значений и сообщений. Кроме этого выполняет задачу активного сбора данных из источников значений для архивов значений, а также архивирование архива сообщений по архиваторам.

Архив значений (TVArchive) содержит буфер (TValBuf) для промежуточного накопления значений перед архивированием. Связывается с источником значений в лице параметров системы OpenSCADA в активном или пассивном режиме, а также с другими источниками в пассивном режиме. Для архивирования на физические хранилища связывается с архиваторами значений различных типов.

Объект буфера TValBuf содержит массив значений основных типов системы OpenSCADA: строка, целое, вещественное и логичное. Поддерживается хранение значений в режимах жесткой, мягкой сетки и режиме свободного доступа. Предусмотрен также режим времени высокого разрешения (микросекунды). Используется как для непосредственного хранения больших массивов значений, так и для обмена с большими массивами методом покадрового доступа.

Корневой объект модуля подсистемы "Архивы" (TTypeArchivator) содержит информацию о конкретно взятом типе модуля. В рамках отдельных модулей может реализовывать собственные общемодульные функции. В общем для модулей этого типа содержит методы доступа к хранилищам значений и сообщений.

Объект архиватора сообщений (TMArchivator) содержит конкретную реализацию хранилища сообщений. В общем для архиваторов сообщений предоставляется интерфейс доступа к реализации механизма архивирования в модулях.

Объект архиватора значений (TVArchivator) содержит конкретную реализацию хранилища значений. В общем для архиваторов значений предоставляется интерфейс доступа к реализации механизма архивирования и назначение архивов значений на обслуживание архиватором.

Объект элемента архива TVArchEl связывает объекты архивов с архиваторами. Используется для доступа к архиваторам из архива, а также к архивам из архиватора, т.е. для перекрёстных вызовов.

5.1. Объект подсистемы "Архивы" (TArchiveS)

Наследует:

SubSYS.

Публичные методы:

int subVer( ); — Версия подсистемы.
int messPeriod( ); — Период архивирование сообщений из буфера (секунд).
int valPeriod( ); — Период сбора значений для активных архиваторов (миллисекунд).
int valPrior( ); — Приоритет задачи сбора значений для активных архиваторов.
bool valForceCurTm( ); — Указывает на принудительную установку текущего время в качестве метки времени получаемого значения.
void setMessPeriod( int ivl ); — Установка периода архивирования сообщений из буфера (секунд).
void setValPeriod( int ivl ); — Установка периода сбора значений для активных архиваторов (миллисекунд).
void setValPrior( int ivl ); — Установка приоритета задачи сбора значений для активных архиваторов.
void setValForceCurTm( bool vl ); — Принудительная установка текущего время в качестве метки времени получаемого значения.
void setToUpdate( ); — Установка флага планирования обновления.
void subStart( ); — Запуск подсистемы.
void subStop( ); — Останов подсистемы.
void valList( vector<string> &list ) const; — Список архивов значений в подсистеме.
bool valPresent( const string &iid ) const; — Проверка на наличие архива значений iid.
void valAdd( const string &iid, const string &idb = "*.*" ); — Добавление нового архива значений iid.
void valDel( const string &iid, bool db = false ); — Удаление архива значений iid.
AutoHD<TVArchive> valAt( const string &iid ) const; — Подключение/обращение к архиву значений iid.
void setActMess( TMArchivator *a, bool val ); — Установка архиватора сообщений a в активное состояние val. Активный архиватор будет подсистемой обеспечиваться потоком сообщений.
void setActVal( TVArchive *a, bool val ); — Установка архива значений a в активное состояние val. Активный архив будет подсистемой обеспечиваться периодическим потоком значений (определяется периодичностью архива).
AutoHD<TTypeArchivator> at( const string &name ); — Подключение/обращение к типу архиватора (модулю) name.
void messPut( time_t tm, int utm, const string &categ, int8_t level, const string &mess, const string &arch = "", bool force = false ); — Помещение значения mess с уровнем level категории categ и время tm+utm в буфер, а затем в архив сообщений или прямо в указанный архиваторы arch (разделены символом ';'). force для прямой записи в архиватор минуя резервирование.
void messPut( const vector<TMess::SRec> &recs, const string &arch = "", bool force = false ); — Помещение группы значений recs в буфер, а затем в архив сообщений или прямо в указанный архиваторы arch (разделены символом ';'). force для прямой записи в архиватор минуя резервирование.
time_t messGet( time_t bTm, time_t eTm, vector<TMess::SRec> &recs, const string &category = "", int8_t level = TMess::Debug, const string &arch = "", time_t upTo = 0 ); — Запрос значений reqs за указанный период времени bTm, eTm для указанной категории (по шаблону) category и уровня level из архиваторов arch (разделены символом ';'). Возвращает время остановки запроса, полезно для продолжения с указанной точки.
time_t messBeg( const string &arch = "" ); — Начало архива сообщений в целом или для указанного архиватора arch.
time_t messEnd( const string &arch = "" ); — Конец архива сообщений в целом или для указанного архиватора arch.
float rdRestDtOverTm( ); — Глубина принудительной перезагрузки истории резерва при запуске, в сутках.
void setRdRestDtOverTm( float vl ); — Установка глубины принудительной перезагрузки истории резерва при запуске, в сутках.
void rdActArchMList( vector<string> &ls, bool isRun = false ); — Список активных архиваторов сообщений, работающих в схеме резервирования. При указании isRun в список попадут только исполняющиеся на данной станции архиваторы сообщения.
string rdStRequest( const string &arch, XMLNode &req, const string &prevSt = "", bool toRun = true ); — Запрос req к резервной станции от имени архиватора сообщения arch. Станция для запроса выбирается после указанной в prevSt, для исполняемого удалённо архиватора сообщений, при указании toRun.
TElem &messE( ); — Структура БД архиваторов сообщений.
TElem &valE( ); — Структура БД архиваторов значений.
TElem &aValE( ); — Структура БД архивов значений.

Публичные атрибуты:

bool SubStarting; — Признак запуска подсистемы.

5.2. Объект архива значений (TVArchive)

Наследует:

TCntrNode, TValBuf, TConfig

Данные:
Режим сбора данных/источник (struct — TVArchive::SrcMode):

Passive — пассивный режим сбора данных, источник самостоятельно помещает данные в архив;
PassiveAttr — пассивный режим сбора данных у атрибута параметра, атрибут параметра самостоятельно помещает данные в архив;
ActiveAttr — активный режим сбора данных у атрибута параметра, атрибут параметра периодически опрашивается подсистемой "Архивы".

Публичные методы:

TVArchive( const string &id, const string &db, TElem *cf_el ); — Инициализирующий конструктор архива. Где id — идентификатор архива, db — БД для хранения и cf_el — cтруктура БД архивов значений.
string id( ); — Идентификатор архива.
string name( ); — Имя архива.
string dscr( ); — Описание архива.
SrcMode srcMode( ); — Режим связывания с источником данных.
string srcData( ); — Параметры источника данных, в случае режима доступа к параметру это адрес параметра.
AutoHD<TVal> srcPAttr( bool force = false, const string &ipath = "" ); — Подключение к ассоциированному атрибуту параметра источника данных.
bool toStart( ); — Признак: "Запускать архив при включении".
bool startStat( ) const; — Состояние: "Архив запущен".
string DB( ); — Адрес БД архива значений.
string tbl( ); — Таблица БД архива значений.
string fullDB( ); — Полное имя таблицы БД архива значений.
int64_t end( const string &arch = BUF_ARCH_NM ); — Время окончания архива в целом (arch="") или указанного архиватора, буфера (arch="<bufer>").
int64_t begin( const string &arch = BUF_ARCH_NM ); — Время начала архива в целом (arch="") или указанного архиватора, буфера (arch="<bufer>").
int64_t period( const string &arch = BUF_ARCH_NM ); — Периодичность буфера архива или указанного архиватора (микросекунд).
TFld::Type valType( bool full = false ); — Тип архивируемого значения. full — получать полный тип, иначе только общий.
bool hardGrid( ); — Использование жесткой сетки в буфере архива.
bool highResTm( ); — Использование высокого разрешения времени в буфере архива (микросекунды).
bool fillLast( ); — Заполнение проходных точек последним значением. В основном проходные значения заполняются EVAL однако иногда периодичность значений источника больше периодичности этого архива и это нормально.
int size( ); — Размер буфера архива (единицы).
void setName( const string &inm ); — Установка имени архива.
void setDscr( const string &idscr ); — Установка описания архива.
void setSrcMode( SrcMode vl = SaveCur, const string &isrc = "<*>", bool noex = false ); — Установка режима связывания с источником данных.
void setToStart( bool vl ); — Установка признака: "Запускать архив при включении".
void setDB( const string &idb ); — Установка адреса БД архива значений.
void setValType( TFld::Type vl ); — Установка типа архивируемого значения.
void setHardGrid( bool vl ); — Установка использования жесткой сетки в буфере архива.
void setHighResTm( bool vl ); — Установка использования высокого разрешения времени в буфере архива (микросекунды).
void setFillLast( bool vl ); — Установка заполнения проходных точек последним значением.
void setSize( int vl ); — Установка размера буфера архива (единиц).
void setPeriod( int64_t vl ); — Установка периодичности буфера архива.
void start( ); — Запуск архива.
void stop( bool full_del = false ); — Останов архива, с полным удалением full_del.
TVariant getVal( int64_t *tm = NULL, bool up_ord = false, const string &arch = "", bool onlyLocal = false ); — Запрос одного значения за время tm и признаком притягивания к верху <up_ord> из указанного архиватора <arch>, буфера (arch="<bufer>") или всех архиваторов по мере падения качества (arch=""). Для обработки запроса только локальной станцией устанавиливается <onlyLocal>.
void getVals( TValBuf &buf, int64_t beg = 0, int64_t end = 0, const string &arch = "", int limit = 100000, bool onlyLocal = false ); — Запрос кадра значений buf за время от beg до end из указанного архиватора arch, буфера (arch="<bufer>") или всех архиваторов по мере падения качества (arch=""), с ограничением размера запроса в limit записей. Для запроса только локальных архивов, без компенсации пробелов архивов из резервных станций, устанавливается onlyLocal.
void setVals( TValBuf &buf, int64_t beg, int64_t end, const string &arch ); — Загрузка кадра значений buf за время от beg до end в указанный архиватор arch, буфер (arch="<bufer>") или все архиваторы (arch="").
void getActiveData( const int64_t &tm = 0 ); — Опросить источник данных с принудительной установкой метки времени в tm (не нулевое). Используется подсистемой для периодического сборa данных активными архивами.
void archivatorList( vector<string> &ls ); — Список архиваторов, которыми обслуживается архив.
bool archivatorPresent( const string &arch ); — Проверка архиватора на обслуживание данного архива.
void archivatorAttach( const string &arch ); — Подключение данного архива на обслуживание указанным архиватором.
void archivatorDetach( const string &arch, bool full = false ); — Отключение данного архива от обслуживание указанным архиватором.
void archivatorSort( ); — Сортировка обслуживающих архиваторов в порядке ухудшения качества.
string makeTrendImg( int64_t beg, int64_t end, const string &arch, int hsz = 650, int vsz = 230 ); — Формирование изображения (pdf) тренда за указанный промежуток времени beg, end и указанного архиватора arch.
TArchiveS &owner( ) const; — Подсистема "Архивы" — владелец архива значений.

5.3. Объект буфера значений (TValBuf)

Наследуется:

TVArchive

Публичные методы:

TValBuf( ); — Инициализатор буфера с установками по умолчанию.
TValBuf( TFld::Type vtp, int isz, int64_t ipr, bool ihgrd = false, bool ihres = false ); — Инициализатор буфера с указанными параметрами.
TValBuf( const TValBuf &src ); — Копирующий конструктор.
TValBuf &operator=( const TValBuf &src ); — Копирование объекта.
void clear( ); — Очистка буфера.
TFld::Type valType( bool full = false ); — Тип значения, хранимого буфером. full — получать полный тип, иначе только общий.
bool hardGrid( ); — Работа буфера в режиме жесткой сетки.
bool highResTm( ); — Работа буфера в режиме времени высокого разрешения (микросекунды).
bool fillLast( ); — Заполнение проходных точек последним значением. В основном проходные значения заполняются EVAL однако иногда периодичность значений источника больше периодичности этого архива и это нормально.
int size( ); — Максимальный размер буфера (едениц).
int realSize( ); — Реальный размер буфера (едениц).
int64_t period( ); — Периодичность значений в буфере (микросекунд). Если периодичность нулевая то буфер функционирует в режиме свободного доступа.
int64_t begin( ); — Время начала буфера (микросекунд).
int64_t end( ); — Время окончания буфера (микросекунд).
bool vOK( int64_t ibeg, int64_t iend ); — Проверка наличия значений в буфере за указанный промежуток времени от ibeg до iend.
void setValType( TFld::Type vl ); — Установка типа значения хранимого буфером.
void setHardGrid( bool vl ); — Установка режима жесткой сетки.
void setHighResTm( bool vl ); — Установка режима времени высокого разрешения (микросекунды).
void setFillLast( bool vl ); — Установка заполнения проходных точек последним значением.
void setSize( int vl ); — Установка размера буфера (едениц).
void setPeriod( int64_t vl ); — Установка периодичности значений в буфере (микросекунд).
virtual void getVals( TValBuf &buf, int64_t beg = 0, int64_t end = 0 ); — Запрос кадра значений buf за время от beg до end.
TVariant get( int64_t *tm = NULL, bool up_ord = false ); — Запрос значения за время tm и признаком притягивания к верху up_ord.
virtual string getS( int64_t *tm = NULL, bool up_ord = false ); — Запрос значения строкового типа за время tm и признаком притягивания к верху up_ord.
virtual double getR( int64_t *tm = NULL, bool up_ord = false ); — Запрос значения вещественного типа за время tm и признаком притягивания к верху up_ord.
virtual int64_t getI( int64_t *tm = NULL, bool up_ord = false ); — Запрос значения целого типа за время tm и признаком притягивания к верху up_ord.
virtual char getB( int64_t *tm = NULL, bool up_ord = false ); — Запрос значения логического типа за время tm и признаком притягивания к верху up_ord.
virtual void setVals( TValBuf &buf, int64_t beg = 0, int64_t end = 0 ); — Установка кадра значений из buf за время от beg до end.
void set( const TVariant &value, int64_t tm = 0 ); — Установка значения с временем tm.
virtual void setS( const string &value, int64_t tm = 0 ); — Установка значения строкового типа с временем tm.
virtual void setR( double value, int64_t tm = 0 ); — Установка значения вещественного типа с временем tm.
virtual void setI( int64_t value, int64_t tm = 0 ); — Установка значения целого типа с временем tm.
virtual void setB( char value, int64_t tm = 0 ); — Установка значения логического типа с временем tm.
//

Защищённые методы:

void makeBuf( TFld::Type v_tp, int isz, int64_t ipr, bool hd_grd, bool hg_res ); — Пересоздание буфера для указанных параметров.

5.4. Модульный объект типа архиватора (TTypeArchivator)

Наследует:	TModule.
Наследуется:	Корневыми объектами модулей подсистемы "Архивы".

Публичные методы:

void messList( vector<string> &list ) const; — Список архиваторов сообщений.
bool messPresent( const string &iid ) const; — Проверка на наличие указанного архиватора сообщений.
void messAdd( const string &iid, const string &idb = "*.*" ); — Добавление архиватора сообщений.
void messDel( const string &iid, bool full = false ); — Удаление архиватора сообщений.
AutoHD<TMArchivator> messAt( const string &iid ) const; — Подключение к архиватору сообщений.
void valList( vector<string> &list ) const; — Список архиваторов значений.
bool valPresent( const string &iid ) const; — Проверка на наличие указанного архиватора значений.
void valAdd( const string &iid, const string &idb = "*.*" ); — Добавление архиватора значений.
void valDel( const string &iid, bool full = false ); — Удаление архиватора значений.
AutoHD<TVArchivator> valAt( const string &iid ) const; — Подключение к архиватору значений.
TArchiveS &owner( ) const; — Подсистема "Архивы" — владелец типа архиватора.

Защищённые методы:

virtual TMArchivator *AMess( const string &iid, const string &idb ); — Модульный метод создание архиватора сообщений.
virtual TVArchivator *AVal( const string &iid, const string &idb ); — Модульный метод создание архиватора значений.

5.5. Объект архиватора сообщений (TMArchivator)

Наследует:	TCntrNode, TConfig
Наследуется:	Объектами архиваторов сообщений модулей подсистемы "Архивы".

Публичные методы:

TMArchivator( const string &id, const string &db, TElem *cf_el ); — Инициализирующий конструктор архиватора сообщений с идентификатором id, для хранения на БД db со структурой cf_el.
string id( ); — Идентификатор архиватора.
string workId( ); — Рабочий идентификатор, включает имя модуля.
string name( ); — Имя архиватора.
string dscr( ); — Описание архиватора.
bool toStart( ); — Признак "Запускать архиватор".
bool startStat( ) const; — Состояние архиватора "Запущен".
string &addr( ) const; — Адрес хранилища архиватора.
int &level( ); — Уровень сообщений, обслуживаемых архиватором.
void categ( vector<string> &list ); — Категории (шаблоны) сообщений, обслуживаемых архиватором.
string DB( ); — Адрес БД архиватора.
string tbl( ); — Адрес таблицы БД архиватора.
string fullDB( ); — Полный адрес таблицы БД архиватора.
void setName( const string &vl ); — Установка имени архиватора.
void setDscr( const string &vl ); — Установка описания архиватора.
void setToStart( bool vl ); — Установка признака "Запускать архиватор".
void setAddr( const string &vl ); — Установка адреса хранилища архиватора.
void setLevel( int lev ); — Установка уровня сообщений, обслуживаемых архиватором.
void setDB( const string &idb ); — Установка адреса БД архиватора.
bool redntUse( ); — Режим получения данных у резервной станции.
void setRedntUse( bool vl ); — Смена режима получения данных у резервной станции.
bool redntMode( ); — Режим резервирования ("<high>", "<low>", "<optimal>", {ForceStation}), включение.
void setRedntMode( bool vl ); — Установка режима резервирования, включение.
string redntRun( ); — Конфигурация предпочтительного исполнения.
void setRedntRun( const string &vl ); — Установка конфигурации предпочтительного исполнения.
virtual void redntDataUpdate( ); — Выполнение операции получения данных из резервной станции. Вызывается автоматически процедурой обслуживания схемы резервирования подсистемы.
virtual void start( ); — Запуск архиватора.
virtual void stop( ); — Останов архиватора.
virtual time_t begin( ); — Начало архива данного архиватора.
virtual time_t end( ); — Конец архива данного архиватора.
virtual bool put( vector<TMess::SRec> &mess, bool force = false ); — Поместить группу сообщений в архив сообщений данного архиватора. Возвращает "true", при успешной операции. force для прямой записи в архиватор минуя резервирование.
virtual time_t get( time_t bTm, time_t eTm, vector<TMess::SRec> &mess, const string &category = "", char level = 0, time_t upTo = 0 ); — Получить сообщения из архива данного архиватора для указанных параметров фильтра. Возвращает время остановки запроса, полезно для продолжения с указанной точки.
TTypeArchivator &owner( ) const; — Тип архиватора – владелец архиватора сообщений.

Защищённые атрибуты:

bool run_st; — Признак "Запущен".
int messHead; — Указатель на последнее прочитанное сообщений буфера сообщений.

Защищённые методы:

bool chkMessOK( const string &icateg, int8_t ilvl ); — Проверка сообщения на соответствие условиям фильтра.

5.6. Объект архиватора значений (TVArchivator)

Наследует:	TCntrNode, TConfig
Наследуется:	Объектами архиваторов значений модулей подсистемы "Архивы".

Публичные методы:

TVArchivator( const string &id, const string &db, TElem *cf_el ); — Инициализирующий конструктор архиватора значений с идентификатором id, для хранения на БД db со структурой cf_el.
string id( ); — Идентификатор архиватора.
string workId( ); — Рабочий идентификатор, включает имя модуля.
string name( ); — Имя архиватора.
string dscr( ); — Описание архиватора.
string addr( ) const; — Адрес хранилища архиватора.
double valPeriod( ); — Периодичность значений архиватора (микросекунд).
int archPeriod( ); — Периодичность архивирования значений архиватором. Время через которое архиватор производит архивирование кадра значений из буфера архива.
int selPrior( ); — Приоритет выбора для режима "Все" архиваторы.
bool toStart( ); — Признак "Запускать архиватор".
bool startStat( ) const; — Состояние архиватора "Запущен".
string DB( ); — Адрес БД архиватора.
string tbl( ); — Адрес таблицы БД архиватора.
string fullDB( ); — Полный адрес таблицы БД архиватора.
void setName( const string &inm ); — Установка имени архиватора.
void setDscr( const string &idscr ); — Установка описания архиватора.
void setAddr( const string &vl ); — Установка адреса хранилища архиватора.
void setValPeriod( double iper ); — Установка периодичности значений архиватора (микросекунд).
void setArchPeriod( int iper ); — Установка периодичности архивирования значений архиватором. Время через которое архиватор производит архивирование кадра значений из буфера архива.
void setSelPrior( int vl ); — Установка приоритета выбора для режима "Все" архиваторы.
void setToStart( bool vl ); — Установка признака "Запускать арзиватор".
void setDB( const string &idb ); — Установка адреса БД архиватора.
virtual void start( ); — Запуск архиватора.
virtual void stop( bool full_del = false ); — Останов архиватора с возможностью полного удаления full_del.
void archiveList( vector<string> &ls ); — Список архивов обслуживаемых архиватором.
bool archivePresent( const string &iid ); — Проверка на обслуживаемость указанного архива архиватором.
TTypeArchivator &owner( ) const; — Тип архиватора – владелец архиватора значений.

Защищённые методы:

TVArchEl *archivePlace( TVArchive &item ); — Включить архив item в обработку архиватором.
void archiveRemove( const string &id, bool full = false ); — Удалить архив id из обработки архиватором, с возможностью полного удаления full.
virtual TVArchEl *getArchEl( TVArchive &arch ); — Получение объекта элемента архива для указанного архива.
virtual void pushAccumVals( ); — Выгрузка аккумулированных задачей архивации значений, для аккумулирующих архиваторов.

Защищённые атрибуты:

Res a_res — Ресурс процесса архивирования.
bool run_st — Признак "Архив запущен".
vector<TVArchEl *> arch_el; — Массив элементов архивов.

5.7. Объект элемента архива в архиваторе (TVArchEl)

Наследуется:

Объектами архиваторов значений модулей подсистемы "Архивы".

Публичные методы:

TVArchEl( TVArchive &iarchive, TVArchivator &iarchivator ); — Инициализирующий конструктор для связи архива iarchive с архиватором iarchivator.
virtual void fullErase( ); — Полное удаление элемента.
virtual int64_t end( ); — Время конца данных (микросекунды).
virtual int64_t begin( ); — Время начала данных (микросекунды).
int64_t lastGet( ); — Время последнего сброса данных из буфера в хранилище.
TVariant getVal( int64_t *tm, bool up_ord, bool onlyLocal = false ); — Запрос значения за время tm и признаком притягивания к верху up_ord, с указанием запроса только локального архива в onlyLocal.
void getVals( TValBuf &buf, int64_t beg = 0, int64_t end = 0, bool onlyLocal = false ); — Запрос кадра значений buf за время от beg до end, с указанием запроса только локального архива в onlyLocal.
void setVals( TValBuf &buf, int64_t beg = 0, int64_t end = 0, bool toAccum = false ); — Установка кадра значений из buf за время от beg до end, через аккумуляцию toAccum.
TVArchive &archive( ); — Архив элемента.
TVArchivator &archivator( ); — Архиватор элемента.

Публичные атрибуты:

int64_t prev_tm; — Время предыдущего значения. Используется для усреднения.
string prev_val; — Предыдущее значение. Используется для усреднения.

Защищённые методы:

virtual TVariant getValProc( int64_t *tm, bool up_ord ); — Функция обработки запроса одного значения из архива.
virtual void getValsProc( TValBuf &buf, int64_t beg, int64_t end ); — Функция обработки запроса модулем на получение данных.
virtual void setValsProc( TValBuf &buf, int64_t beg, int64_t end, bool toAccum ); — Функция обработки запроса модулем на установку данных, через аккумуляцию toAccum.

6. Подсистема "Транспорты" (TTransportS)

Подсистема "Транспорты" представлена объектом TTransportS, который содержит на уровне подсистемы модульные объекты типов транспортов TTypeTransport. Каждый тип транспорта содержит объекты входящих TTransportIn и исходящих TTransportOut транспортов. Общая структура подсистемы приведена на рис. 6.

Иерархическая структура подсистемы транспортов (14 Кб)

Рис. 6. Слоистая структура подсистемы транспортов.

Корневой объект модуля подсистемы "Транспорты" содержит информацию о конкретно взятом типе модуля и внешних OpenSCADA хостах/станциях. В рамках отдельно взятого модуля может быть реализована собственная общемодульная функциональность. В общем, для всех модулей, содержатся методы доступа к входящим и исходящим транспортам конкретно взятого модуля.

Объект входящего транспорта TTransportIn предоставляет интерфейс к реализации модульного метода входящего транспорта.

Объект исходящего транспорта TTransportOut предоставляет интерфейс к реализации модульного метода исходящего транспорта.

6.1. Объект подсистемы "Транспорты" (TTransportS)

Наследует:

TSubSYS.

Данные:
Режимы внешних хостов (enum — ExtHost::Mode):

User (0) — Пользовательский.
System (1) — Системный.
UserSystem (2) — Пользовательский и Системный.

Структура внешних OpenSCADA хостов/станций (class TTransportS::ExtHost):

ExtHost( const string &iUserOpen, const string &iid, const string &iname = "", const string &itransp = "", const string &iaddr = "", const string &iuser = "", const string &ipass = "", uint8_t iUpRiseLev = 0 ); — Конструктор инициализации структуры.
string userOpen; — Пользователь, создавший запись про внешний хост/станцию.
string id; — Идентификатор внешнего хоста/станции.
string name; — Имя внешнего хоста/станции.
string transp; — Транспорт, использующийся для доступа к внешнему хосту/станции.
string addr; — Адрес для транспорта, который используется для доступа к внешнему хосту/станции.
string user; — Пользователь внешнего хоста/станции.
string pass; — Пароль пользователя внешнего хоста/станции.
uint8_t upRiseLev; — Уровень/глубина поднятия внешних станций самого этого хоста/станции.
int8_t mode; — Режим хоста.
time_t mdf; — Время модификации.

Публичные методы:

int subVer( ); — Версия подсистемы.
void inTrList( vector<string> &ls ); — Полный список входящих транспортов.
void outTrList( vector<string> &ls ); — Полный список исходящих транспортов.
string extHostsDB( ); — БД хранения перечня внешних хостов.
void extHostList( const string &user, vector<ExtHost> &list, bool andSYS = false, int upRiseLev = -1 ); — Список внешних хостов list для пользователя user, включая системные andSYS и уровня поднятия upRiseLev (-1 - начинать с уровня в записи хоста).
ExtHost extHostGet( const string &user, const string &id, bool andSYS = false ); — Получение информационного объекта внешнего хоста id от имени пользователя user, включая системный andSYS ("*" — строго для системных хостов).
AutoHD<TTransportOut> extHost( TTransportS::ExtHost host, const string &pref = "" ); — Создание - запрос исходящего транспорта для обслуживания внешнего хоста host с префиксом идентификации узла системы pref.
void extHostSet( const ExtHost &host, bool andSYS = false ); — Установка внешнего хоста/станции host, включая системный andSYS.
void extHostDel( const string &user, const string &id, bool andSYS = false ); — Удаление внешнего хоста/станции id от имени пользователя user, включая системный andSYS ("*" — для системных хостов).
int cntrIfCmd( XMLNode &node, const string &senderPref, const string &user = "" ); — Передача запроса интерфейса управления OpenSCADA node к удалённой станции.
void subStart( ); — Запуск подсистемы.
void subStop( ); — Останов подсистемы.
TElem &inEl( ); — Структура БД входящих транспортов.
TElem &outEl( ); — Структура БД исходящих транспортов.
AutoHD<TTypeTransport> at( const string &id ) const; — Обращение/подключение к типу транспорта id.

6.2. Модульный объект типа транспортов (TTypeTransport)

Наследует:	TModule.
Наследуется:	Корневыми объектами модулей подсистемы "Транспорты".

Публичные методы:

void inList( vector<string> &list ) const; — Список входящих транспортов.
bool inPresent( const string &name ) const; — Проверка на наличие входящего транспорта.
void inAdd( const string &name, const string &db = "*.*" ); — Добавление входящего транспорта.
void inDel( const string &name, bool complete = false ); — Удаление входящего транспорта. Возможно полное удаление, включающее и БД, путём установки признака complete.
AutoHD<TTransportIn> inAt( const string &name ) const; — Подключение к входящему транспорту.
void outList( vector<string> &list ) const; — Список исходящих транспортов.
bool outPresent( const string &name ) const; — Проверка на наличие исходящего транспорта.
void outAdd( const string &name, const string &db = "*.*" ); — Добавление исходящего транспорта.
void outDel( const string &name, bool complete = false ); — Удаление исходящего транспорта. Возможно полное удаление, включающее и БД, путём установки признака complete.
AutoHD<TTransportOut> outAt( const string &name ) const; — Подключение к исходящему транспорту.
TTransportS &owner( ) const; — Подсистема "Транспорты" — владелец типом транспорта.

Защищённые методы:

virtual TTransportIn *In( const string &name, const string &db ); — Модульный метод создания/открытия нового "Входящего" транспорта.
virtual TTransportOut *Out( const string &name, const string &db ); — Модульный метод создания/открытия нового "Исходящего" транспорта.

6.3. Объект входящих транспортов (TTransportIn)

Наследует:	TCntrNode, TConfig.
Наследуется:	Объектами входящих транспортов модулей подсистемы "Транспорты".

Публичные методы:

TTransportIn( const string &id, const string &db, TElem *el ); — Инициализирующий конструктор.
string id( ); — Идентификатор транспорта.
string workId( ); — Полный идентификатор, включая идентификатор модуля.
string name( ); — Имя транспорта.
string dscr( ); — Описание транспорта.
string addr( ) const; — Адрес.
string protocol( ); — Связанный транспортный протокол.
virtual string getStatus( ); — Получение статуса входящего транспорта.
bool toStart( ); — Признак "Запускать транспорт".
bool startStat( ) const; — Состояние "Транспорт запущен".
string DB( ); — Адрес БД транспорта.
string tbl( ); — Таблица БД транспорта.
string fullDB( ); — Полное имя таблицы БД транспорта.
void setName( const string &inm ); — Установка имени транспорта в inm.
void setDscr( const string &idscr ); — Установка описания транспорта в idscr.
void setAddr( const string &addr ); — Установка адреса транспорта в addr.
void setProtocol( const string &prt ); — Установка связного транспортного протокола.
void setToStart( bool val ); — Установка признака "Запускать транспорт".
void setDB( const string &vl ); — Установка адреса БД транспорта.
virtual void start( ); — Запуск транспорта.
virtual void stop( ); — Останов транспорта.
virtual int writeTo( const string &sender, const string &data ); — Отправка данных data назад отправителю sender.
vector<AutoHD<TTransportOut> > assTrs( bool checkForCleanDisabled = false ); — Массив связанных исходящих транспортов, созданных входящим транспортом для типовых запросов к инициатору подключения. Установить checkForCleanDisabled для предварительной проверки и очистки отключенных.
int logLen( ); — длина лога ВВ.
void setLogLen( int vl ); — установка длины лога ВВ.
void pushLogMess( const string &vl ); — поместить сообщение vl в лог в формате "{Message}\n{BinData}".
TTypeTransport &owner( ) const; — Тип транспорта – владелец входящим транспортом.

Защищённые методы:

string assTrO( const string &addr ); — Создание связанного исходящего транспорта с адресом addr.

Защищённые атрибуты:

bool run_st; — Признак "Запущен".

6.4. Объект исходящих транспортов (TTransportOut)

Наследует:	TCntrNode, TConfig.
Наследуется:	Объектами исходящих транспортов модулей подсистемы "Транспорты".

Публичные методы:

TTransportOut( const string &id, const string &db, TElem *el ); — Инициализирующий конструктор.
string id( ); — Идентификатор транспорта.
string workId( ); — Полный идентификатор, включая идентификатор модуля.
string name( ); — Имя транспорта.
string dscr( ); — Описание транспорта.
string addr( ) const; — Адрес транспорта.
virtual string timings( ); — Таймауты транспорта.
int prm1( ); — Первый резервный параметр.
int prm2( ); — Второй резервный параметр.
bool toStart( ); — Признак "Запускать транспорт".
bool startStat( ) const; — Состояние "Транспорт запущен".
time_t startTm( ); — Состояние "Время запуска/подключения".
virtual string getStatus( ); — Получение статуса транспорта.
string DB( ); — Адрес БД транспорта.
string tbl( ); — Таблица БД транспорта.
string fullDB( ); — Полное имя таблицы БД транспорта.
void setName( const string &inm ); — Установка имени транспорта.
void setDscr( const string &idscr ); — Установка описания транспорта.
void setAddr( const string &addr ); — Установка адреса транспорта.
virtual void setTimings( const string &vl ); — Установка таймаутов транспорта.
void setPrm1( int vl ); — Установка первого резервного параметра.
void setPrm2( int vl ); — Установка второго резервного параметра.
void setToStart( bool val ); — Установка признака "Запускать транспорт".
void setDB( const string &vl ); — Установка адреса БД транспорта.
virtual void start( int time = 0 ); — Запуск транспорта с временем подключения time.
virtual void stop( ); — Останов транспорта.
virtual int messIO( const char *oBuf, int oLen, char *iBuf = NULL, int iLen = 0, int time = 0 ); — Отправка данных через транспорт. Время ожидания time соединения (в миллисекундах). Отрицательное время time отключает работу транспорта в режиме запрос/ответ и позволяет независимо читать/писать в буфер ВВ, с таймаутом чтения time в абсолютном значении.
void messProtIO( XMLNode &io, const string &prot ); — Отправка данных в дереве XML in через транспорт, используя транспортный протокол prot.
int logLen( ); — длина лога ВВ.
void setLogLen( int vl ); — установка длины лога ВВ.
void pushLogMess( const string &vl ); — поместить сообщение vl в лог в формате "{Message}\n{BinData}".
TTypeTransport &owner( ) const; — Тип транспорта – владелец исходящим транспортом.
ResMtx &reqRes( ); — Запросный ресурс, который должен быть глобально захватываем в протоколах с получением фрагментов.

Защищённые атрибуты:

bool run_st; — Признак "Запущен".

7. Подсистема "Протоколы коммуникационных интерфейсов" (TProtocolS)

Подсистема "Протоколы коммуникационных интерфейсов" представлена объектом TProtocolS, который содержит на уровне подсистемы модульные объекты отдельных протоколов TProtocol. Каждый протокол содержит объекты открытых сеансов входящих протоколов TProtocolIn.

Объект TProtocolS предоставляет доступ к входящим и исходящим протоколам отдельно взятых типов транспортных протоколов. Внутренняя сторона исходящего протокола строится по потоковому принципу с индивидуальной структурой потока для каждой реализации протокола.

7.1. Объект подсистемы "Протоколы коммуникационных интерфейсов" (TProtocolS)

Наследует:

TSubSYS.

Публичные методы:

int subVer( ); — Версия подсистемы.
AutoHD<TProtocol> at( const string &id ) const; — Подключение к модулю протокола id.
string optDescr( ); — Локализованная помощь по опциям командной строки и параметрам конфигурационного файла.

7.2. Модульный объект протокола (TProtocol)

Наследует:	TModule.
Наследуется:	Корневыми объектами модулей подсистемы "Протоколы".

Публичные методы:

virtual void itemListIn( vector<string> &ls, const string &curIt = "" ); — Список элементов протокола для индивидуальной адресации в транспорте.
void list( vector<string> &list ) const; — Список открытых входящих сеансов.
bool openStat( const string &name ) const; — Проверка на открытость входящего сеанса с указанным именем.
void open( const string &name, TTransportIn *tr = NULL, const string &sender = "" ); — Открытие входящего сеанса от имени транспорта tr.
void close( const string &name ); — Закрытие входящего сеанса.
AutoHD<TProtocolIn> at( const string &name ) const; — Подключение к открытому входящему сеансу.
virtual void outMess( XMLNode &io, TTransportOut &tro ); — Отправка данных в дереве XML in посредством данного протокола и транспорта tro.

7.3. Объект сеанса входящего протокола (TProtocolIn)

Наследует:	TCntrNode.
Наследуется:	Объектами сеанса входящего протокола модулей подсистемы "Протоколы".

Публичные методы:

TProtocolIn( const string &name ); — Инициализирующий конструктор.
string name( ); — Имя входящего сеанса.
AutoHD<TTransportIn> &srcTr( ); — Транспорт-источник, открывший данный сеанс входящего протокола.
const string &srcAddr( ) — Адрес отправителя; во второй строке служебная часть адреса для для обратных сообщений.
virtual unsigned waitReqTm( ); — Время ожидания запросов на входящем транспорте (в миллисекундах), после которого обращаться к протоколу с пустым сообщением — режим пула. Установка в ноль отключает режим пула.
virtual void setSrcTr( TTransportIn *vl ); — Установка транспорта-источника открытия данного сеанса входящего протокола.
virtual void setSrcAddr( const string &vl ); — Установка адреса отправителя.
int writeTo( const string &data ); — Отправка данных data сообщения обратно отправителю, в srcAddr().
virtual bool mess( const string &request, string &answer ); — Передача неструктурированных данных на обработку протоколу.
TProtocol &owner( ) const; — Протокол, владелец входящего сеанса.

8. Подсистема "Пользовательские интерфейсы" (TUIS)

Подсистема "Пользовательские интерфейсы" представлена объектом TUIS, который содержит на уровне подсистемы модульные объекты пользовательских интерфейсов TUI.

8.1. Объект подсистемы "Пользовательские интерфейсы" (TUIS)

Наследует:

TSubSYS.

Данные:
Параметры запроса (enum — GetOpts):

GetPathURL (1) — Получение пути.
GetContent (2) — Получение команды открытия документа.

Публичные методы:

int subVer( ); — Версия подсистемы.
void subStart( ); — Запуск подсистемы.
void subStop( ); — Останов подсистемы.
AutoHD<TUI> at( const string &name ) const; — Подключение к модулю пользовательского интерфейса.
static string icoGet( const string &inm, string *tp = NULL, bool retPath = false ); — Загрузка изображения иконки inm из стандартных директорий или возврат пути, при retPath, к доступной иконке. Обнаруживаются иконки для расширений "png", "gif", "jpg", "jpeg", которое возвращается в tp.
static string docGet( const string &inm, string *tp = NULL, unsigned opt = 0 ); — Загрузка документа inm из стандартных директорий или возврат пути, при retPath, к доступному документу. Обнаруживаются документы для расширений "pdf", "html", "odt", которое возвращается в tp.
static string mimeGet( const string &inm, const string &fDt, const string &orig = "" ); — Получение mime типа файла в виде {группа}/{тип} для файла с именем inm, его содержимого fDt и исходного намёка orig.

8.2. Модульный объект пользовательского интерфейса (TUI)

Наследует:	TModule.
Наследуется:	Корневыми объектами модулей подсистемы "Пользовательские интерфейсы".

Защищённые атрибуты:

bool run_st; — Признак "Модуль запущен".

9. Подсистема "Специальные" (TSpecialS)

Подсистема "Специальные" представлена объектом TSpecialS, который содержит на уровне подсистемы модульные объекты специальных TSpecial.

9.1. Объект подсистемы "Специальные" (TSpecialS)

Наследует:

TSubSYS.

Публичные методы:

int subVer( ); — Версия подсистемы.

9.2. Модульный объект специальных (TSpecial)

Наследует:	TModule.
Наследуется:	Корневыми объектами модулей подсистемы "Специальные".

Защищённые атрибуты:

bool run_st; — Признак "Модуль запущен".

10. Подсистема "Безопасность" (TSeсurity)

Подсистема безопасности представлена объектом который содержит объекты групп TGroup и пользователей TUser.

Объект пользователя TUser содержит пользовательскую информацию и выполняет проверку аутентичности пользователя в соответствии с указанным паролем.

Объект пользователя TGroup содержит информацию о группе пользователей и выполняет проверку на принадлежность пользователя к группе.

10.1. Объект подсистемы "Безопасность" (TSeсurity)

Наследует:

TSubSYS.

Публичные данные:

static const string pHashMagic; — Строка-указатель (префикс) пароля в хеше.

Публичные методы:

bool access( const string &user, char mode, int owner, int groups, int access ); — Проверка доступа для пользователя user в режиме mode к ресурсу с владельцем owner, группами groups (разделитель ',') и правами access.
void usrList( vector<string> &list ) const; — Список пользователей list.
void usrGrpList( const string &name, vector<string> &list ); — Список групп пользователей list, в которые пользователь name включён.
bool usrPresent( const string &name ) const; — Проверка на наличие указанного пользователя name.
int usrAdd( const string &name, const string &db = "*.*" ); — Добавление пользователя name с хранением в БД db.
void usrDel( const string &name, bool complete = false ); — Удаление пользователя name с возможностью полного удаления complete.
AutoHD<TUser> usrAt( const string &name ) const; — Подключение к пользователю name.
void grpList( vector<string> &list ) const; — Список групп пользователей list.
bool grpPresent( const string &name ) const; — Проверка на наличие указанной группы пользователей name.
int grpAdd( const string &name, const string &db = "*.*" ); — Добавление группы пользователей name с хранением в БД db.
void grpDel( const string &name, bool complete = false ); — Удаление группы пользователей name с возможностью полного удаления complete.
AutoHD<TGroup> grpAt( const string &name ) const; — Подключение к группе пользователей name.

10.2. Объект пользователя (TUser)

Наследует:

TCntrNode, TConfig.

Публичные методы:

TUser( const string &name, const string &db, TElem *el ); — Инициализирующий конструктор.
string name( ); — Имя пользователя.
string descr( ); — Описание пользователя.
string longDescr( ); — Длинное описание пользователя.
string picture( ); — Изображение пользователя.
string lang( ); — Язык пользователя, только в режиме динамической трансляции текстовых переменных.
bool sysItem( ); — Признак системного пользователя.
bool auth( const string &pass, string *hash = NULL ); — Проверка аутентичности пользователя по паролю pass. Хеш пароля, если поддерживается, помещается в hash.
string DB( ); — Адрес БД пользователя.
string tbl( ); — Адрес таблицы БД пользователя.
string fullDB( ); — Полное имя таблицы БД пользователя.
void setDescr( const string &vl ); — Установка описания пользователя в vl.
void setLongDescr( const string &vl ); — Установка длинного описания пользователя в vl.
void setPicture( const string &pct ); — Установка изображения пользователя в pct.
void setLang( const string &vl ); — Установка языка пользователя в vl.
void setPass( const string &pass ); — Установка пароля пользователя в pass.
void setSysItem( bool vl ); — Установка признака системного пользователя в vl.
void setDB( const string &vl ); — Установка адреса БД пользователя.
TSeсurity &owner( ) const; — Подсистема "Безопасность" - владелец пользователя.

10.3. Объект группы пользователей (TGroup)

Наследует:

TCntrNode, TConfig.

Публичные методы:

TGroup( const string &name, const string &db, TElem *el ); — Инициализирующий конструктор.
string name( ); — Имя группы пользователей.
string descr( ); — Описание группы пользователей.
string longDescr( ); — Длинное описание группы пользователей.
bool sysItem( ); — Признак системной группы пользователей.
string DB( ); — Адрес БД группы пользователей.
string tbl( ); — Адрес таблицы БД группы пользователей.
string fullDB( ); — Полное имя таблицы БД группы пользователей.
void setDescr( const string &vl ); — Установка описания группы пользователей в vl.
void setLongDescr( const string &vl ); — Установка длинного описания группы пользователей в vl.
void setSysItem( bool vl ); — Установка признака системной группы пользователей в vl.
void setDB( const string &vl ); — Установка адреса БД группы пользователей.
bool user( const string &name ); — Проверка на принадлежность пользователя к группе name.
void userAdd( const string &name ); — Добавление пользователя name в группу.
void userDel( const string &name ); — Удаление пользователя name из группы.
TSeсurity &owner( ) const; — Подсистема "Безопасность" - владелец группы пользователей.

11. Подсистема "Управление модулями" (TModSchedul)

Подсистема "Управление модулями" представлена объектом TModSchedul.

Подсистема содержит механизм управления модулями, содержащихся в разделяемых библиотеках.

11.1. Объект подсистемы "Управление модулями" (TModSchedul)

Наследует:

TSubSYS.

Данные:
Структура информации о разделяемой библиотеке (struct – TModSchedul::SHD):

void *hd; — заголовок разделяемой библиотеки (если NULL, то библиотека присутствует, но не подключена);
vector<string> use; — список подключенных модулей;
time_t tm; — время модификации библиотеки;
string name; — полное имя/путь разделяемой библиотеки.

Публичные методы:

string allowList( ) const; — Список разрешённых разделяемых библиотек (модулей).
string denyList( ); — Список запрещённых разделяемых библиотек (модулей).
int chkPer( ); — Периода проверки директории с модулями (сек).
void setAllowList( const string &vl ); — Установка списка разрешённых разделяемых библиотек (модулей).
void setDenyList( const string &vl ); — Установка списка запрещённых разделяемых библиотек (модулей).
void setChkPer( int per ); — Установка периода проверки директории с модулями (сек). Если периодичность равна нуль, то проверка будет отключена.
void subStart( ); — Запуск подсистемы.
void subStop( ); — Останов подсистемы.
int loadLibS( ); — Загрузка разделяемых библиотек и инициализация модулей. Возвращает количество загруженных модулей.
SHD &lib( const string &name ); — Получение объекта разделяемой библиотеки name.
void libList( vector<string> &list ); — Список разделяемых библиотек list.
int libLoad( const string &path, bool full ); — Загрузка разделяемых библиотек по указанному пути path. Возвращает количество загруженных модулей.
void libAtt( const string &name, bool full = false); — Подключение указанной разделяемой библиотеке name.
void libDet( const string &name ); — Отключение разделяемой библиотеки name.

12. Компоненты объектной модели системы OpenSCADA

Объектная модель системы OpenSCADA строится на основе объекта функции TFunction, параметрах функции IO и кадре значений функции TValFunc. В последствии объекты функции включаются в объектное дерево, формируя объектную модель системы. Использование функций объектной модели производится путём связывания кадра значений TValFunc с функцией.

Идея в целом доступно представленна на рис. 7.

Основа среды программирования системы OpenSCADA. (71 Кб)

Рис. 7. Основа среды программирования системы OpenSCADA.

Объект функции (TFunction) предоставляет интерфейс для формирования параметров функции и алгоритма вычисления в объекте, наследующем его.

Объект параметра функции (IO) содержит конфигурацию отдельно взятого параметра.

Объект кадра значений (TValFunc) содержит значения в соответствии со структурой связанной функции. При исполнении алгоритма ассоциированой функции используются значения этого объекта.

12.1. Объект функции (TFunction)

Наследует:	TCntrNode
Наследуется:	Модулями и узлами систем, содержащими функции для публикации в объектную модель системы.

Публичные методы:

TFunction( const string &id, const char *grp = "root", const string &stor = "" ); — Инициализирующий конструктор функции с идентификатором id, группой пользователей grp и хранилищем stor.
TFunction( const TFunction &src ); — Копирующий конструктор.
TFunction &operator=( const TFunction &func ); — Копирование функций.
string id( ) const; — Идентификатор функции.
virtual string name( ); — Локализованное имя функции.
virtual string descr( ); — Описание функции.
virtual string prog( ); — Текст программы этой функции, для тех которые не статичны.
virtual string stor( ) const; — БД хранилища, для таблицы "Trs" в основном.
bool startStat( ) const; — Состояние - "Функция запущена".
int use( ); — Счётчик использования функции.
ResRW &fRes( ); — Ссылка на ресурс функции.
void setId( const string &vl ); — Установка идентификатора функции.
virtual void setProg( const string &prg ); — Установка текста программы этой функции, для тех которые не статичны.
void setStor( const string &istor ); — Установить БД хранилища в stor.
virtual void setStart( bool val ); — Запуск/останов val функции.
void ioList( vector<string> &list ); — Список параметров функции list.
int ioId( const string &id ) const; — Получение идентификатора параметра функции id.
int ioSize( ) const; — Количество параметров функции.
IO *io( int id ) const; — Получение параметра функции по индексу id.
void ioAdd( IO *io ); — Добавление параметра функции io.
int ioIns( IO *io, int pos ); — Вставка параметра функции io в позицию pos. Возвращает реальное положение нового параметра.
void ioDel( int pos ); — Удаление параметра функции в позиции pos.
void ioMove( int pos, int to ); — Перемещение параметра функции из позиции pos в позицию to.
virtual void calc( TValFunc *val ); — Вычисление алгоритма функции над указанными значениями val.
virtual void valAtt( TValFunc *vfnc ); — Вызывается объектом кадра значений vfnc в случае связывания с функцией.
virtual void valDet( TValFunc *vfnc ); — Вызывается объектом кадра значений vfnc в случае отвязывания от функции.
virtual void preIOCfgChange( ); — Вызывается перед изменением конфигурации функции.
virtual void postIOCfgChange( ); — Вызывается после изменения конфигурации функции.

Защищённые атрибуты:

string mId; — Идентификатор функции.
bool runSt; — Признак - "Запущен".
bool beStart; — Признак - "Запускать".
TValFunc *mTVal; — Ссылка на объект значений, используемый для тестирования функции. Может отсутствовать.

12.2. Объект параметра функции (IO)

Данные:
Типы параметра (enum — IO::Type):

IO::String — строка/текст;
IO::Integer — целое;
IO::Real — вещественное;
IO::Boolean — логический;
IO::Object — объект.

Флаги параметра (enum — IO::IOFlgs):

IO::Default — режим по умолчанию (вход);
IO::Output — выход;
IO::Return — возврат.

Публичные методы:

IO( const char *id, const char *name, IO::Type type, unsigned flgs, const char *def = "", bool hide = false, const char *rez = "" ); — Инициализирующий конструктор.
IO( const IO &src ); — Копирующий конструктор.
IO &operator=( const IO &iio ); — Копирование параметров функции.
const string &id( ) const; — Идентификатор параметра функции.
const string &name( ) const; — Локализованное имя параметра функции.
const Type &type( ) const; — Тип параметра функции.
unsigned flg( ) const; — Флаги параметра функции.
const string &def( ) const; — Значение по умолчанию.
bool hide( ) const; — Признак - "Скрыто".
const string &rez( ) const; — Резервное свойство параметра функции.
void setId( const string &val ); — Установить идентификатор в val.
void setName( const string &val ); — Установить имя в val.
void setType( Type val ); — Установить тип в val.
void setFlg( unsigned val ); — Установить флаги в val.
void setDef( const string &val ); — Установить значение по умолчанию в val.
void setHide( bool val ); — Установить/снять признак - "Скрыто".
void setRez( const string &val ); — Установить резервное свойство в val.

12.3. Объект значения функции (TValFunc).

Публичные методы:

TValFunc( const string &iname = "", TFunction *ifunc = NULL, bool iblk = true ); — Инициализирующий конструктор.
string user( ); — Пользователь, от имени которого исполняется функция.
string lang( ); — Язык, от которого исполняется функция.
const string &vfName( ); — Имя объекта значений.
bool blk( ); — Признак - "Блокирование изменений параметров функции".
bool dimens( ); — Признак - "Измерять время вычисления".
bool mdfChk( ); — Признак - "Проверка атрибутов на модификацию".
void setUser( const string &iuser ); — Установить пользователя, от имени которого будет исполняться функция.
void setLang( const string &iuser ); — Установить язык, от которого будет исполняться функция.
void setVfName( const string &nm ); — Установить имя объекта значений в nm.
void setDimens( bool set ) — Установка/сброс set признака - "Измерять время вычисления".
void setMdfChk( bool set ); — становка/сброс set признака - "Проверка атрибутов на модификацию".
void ioList( vector<string> &list ); — Список параметров функции list.
int ioId( const string &id ); — Получение индекса параметра id.
int ioSize( ); — Общее количество параметров.
IO::Type ioType( unsigned id ); — Тип параметра id.
unsigned ioFlg( unsigned id ); — Флаги параметра id.
bool ioHide( unsigned id ); — Признак параметра id - "Скрыт".
bool ioMdf( unsigned id ); — Признак параметра id - "Модифицирован".
TVariant get( unsigned id ); — Получить значение параметра id.
string getS( unsigned id ); — Получить значение (строка) параметра id.
int64_t getI( unsigned id ); — Получить значение (целое) параметра id.
double getR( unsigned id ); — Получить значение (вещественное) параметра id.
bool getB( unsigned id ); — Получить значение (логическое) параметра id.
AutoHD<TVarObj> getO( unsigned id ); — Получить значение объекта параметра id.
void set( unsigned id, const TVariant &val ); — Установить значение val параметра id.
void setS( unsigned id, const string &val ); — Установить значение val (строка) параметра id.
void setI( unsigned id, int64_t val ); — Установить значение val (целое) параметра id.
void setR( unsigned id, double val ); — Установить значение val (вещественное) параметра id.
void setB( unsigned id, bool val ); — Установить значение val (логическое) параметра id.
void setO( unsigned id, AutoHD<TVarObj> val ); — Установить значение val объекта параметра id.
virtual void calc( const string &user = "" ); — Вычислить от имени пользователя user или пользователя, установленного ранее.
double calcTm( ); — Время вычисления.
void setCalcTm( double vl ); — Инициализация времени вычисления значением vl.
TFunction *func( ); — Связанная функция.
void setFunc( TFunction *func, bool att_det = true ); — Связать с указанной функцией func.
virtual void preIOCfgChange( ); — Вызывается перед изменением конфигурации.
virtual void postIOCfgChange( ); — Вызывается после изменения конфигурации.
TValFunc *ctxGet( int key ); — Получение контекста для ключа key.
void ctxSet( int key, TValFunc *val ); — Установка контекста для ключа key.
void ctxClear( ); — Очистка контекста вызовов внешних функций.

Публичные атрибуты:

void *exCtx; — Контекст исполнения функции.

13. Данные в системе OpenSCADA и их хранение в БД (TConfig)

Хранение данных в системе основано на объектах TConfig и TElem. Эти объекты хранят структуру и значения полей БД, что позволяет выполнять прямую загрузку и сохранение конфигурации через подсистему "БД". Для специализированного хранения данных разных типов предусмотрен объект TVariant.

Объект TElem содержит структуру записи БД. Структура записи содержит исчерпывающую информацию об элементах, их типах, размерах и остальных параметрах. Информации в данной структуре достаточно для создания, контроля и управления реальной структурой БД. Элементарной единицей записи является ячейка Tfld.

Объект TСonfig является наследником от TElem и содержит реальные значения элементов. TConfig используется в качестве параметра в функциях манипуляции с записями таблиц в подсистеме "БД". Элементарной единицей записи является ячейка TCfg.

Для предоставления возможности предупреждения хранилища данных о смене структуры предусмотрен объект TValElem, от которого наследуется хранилище TConfig и список которых содержится в структуре TElem.

13.1. Объект данных (TConfig)

Наследует:	TValElem
Наследуется:	TParamContr, TController, TMArchivator, TPrmTempl, TPrmTmplLib, TUser, TGroup, TTransportIn, TTransportOut, TBD, TVArchive, TVArchivator, а также модульные объекты хранящие свои данные в БД.

Публичные методы:

TConfig( TElem *Elements = NULL ); — Инициализирующий конструктор.
TConfig( const TConfig &src ); — Копирующий конструктор.
TConfig &operator=( const TConfig &cfg ); TConfig &exclCopy( const TConfig &cfg, const string &passCpLs = "", bool cpElsToSingle = false ); — Копирование из cfg, опуская поля passCpLs и создавая сами поля cpElsToSingle для совмещённых конфигураций.
void cfgList( vector<string> &list ) const; — Список элементов list.
bool cfgPresent( const string &n_val ) const; — Проверка на наличие элемента n_val.
TCfg &cfg( const string &n_val ) const; — Получение элемента n_val.
TCfg *at( const string &n_val, bool noExpt = false ) const; — Получение указателя на элемент n_val. В случае отсутствия элемента генерируется исключение или возвращается нулевой указатель при установке noExpt.
void cfgViewAll( bool val = true ); — Установка/снятие признака видимости для всех элементов.
void cfgKeyUseAll( bool val ); — Установка/снятие признака использования ключа для всех элементов.
TElem &elem( ); — Используемая структура.
void setElem( TElem *Elements, bool first = false ); — Назначение структуры в Elements.
void cntrCmdMake( XMLNode *fld, const string &path, int pos, const string &user = "root", const string &grp = "root", int perm = 0664 ); — Формирование информационного описания элементов конфигурации для интерфейса управления OpenSCADA.
void cntrCmdProc( XMLNode *fld, const string &elem, const string &user = "root", const string &grp = "root", int perm = 0664 ); — Обработка запросов интерфейса управления OpenSCADA к элементам конфигурации.
bool incomplTblStruct( ); — Флаг неполноты структуры БД.
void setIncmplTblStrct( bool vl ); — Установка флага неполноты структуры БД в vl.
bool reqKeys( ); — Признак "Ключ запроса", указание на использование ключа запроса элементами группы.
TVariant objFunc( const string &id, vector<TVariant> &prms, const string &user ); — Объектные функции доступа к конфигурации.

Защищённые методы:

virtual bool cfgChange( TCfg &co, const TVariant &pc ); — Вызывается в случае изменения содержимого элемента конфигурации.

13.2. Ячейка данных (TCfg)

Наследует:

TVariant

Данные:
Дополнительные флаги к TFld (enum — TCfg::AttrFlg):

TCfg::NoVal(0x100) — не отражать элемент на значение объекта TValue.
TCfg::Key(0x200) — ключевое поле.
TCfg::Hide(0x400) — атрибут скрыт.

Флаги запросов (enum — ReqFlg):

TFld::ForceUse(0x01) — Форсирование установки флага использования элемента при установке его значения.
TFld::ExtValOne (0x02) — Один/первое (по умолчанию) значения: значение установки для ключа.
TFld::ExtValTwo (0x04) — Два/второе значение: базовое значение для ключа при запросе или установке.
TFld::ExtValThree (0x08) — Третье значение: адрес источника при переводе.

Публичные методы:

TCfg( TFld &fld, TConfig &owner ); — Инициализирующий конструктор.
TCfg( const TCfg &cfg ); — Копирующий конструктор.
const string &name( ); — Имя ячейки.
bool operator==( TCfg &cfg ); — Сравнение ячеек.
TCfg &operator=( const TCfg &cfg ); — Копирование ячеек.
bool view( ) const; — Признак - "Ячейка видима".
bool keyUse( ) const; — Признак - "Использовать ключ", для запросов dataSeek() и dataDel().
bool noTransl( ) const; — Признак "Отключить перевод" предназначен для отключения механизма перевода текстовых переменных для данной записи.
bool reqKey( ) const; — Признак "Ключ запроса", для выполнения групповых операций по данному полю, как ключу.
bool isKey( ) const; — Сборный признак поля как ключ, в зависимости от режима "Ключ запроса" для группы.
bool extVal( ) const; — Признак "Расширенное значение", для указания совмещения полем роли поиска по ключу и обновления самого ключа и перевода.
void setView( bool vw ); — Установка признака "Ячейка видима" в vw.
void setKeyUse( bool vl ); — Установка признака "Использовать ключ" в vl.
void setNoTransl( bool vl ); — Установка признака "Отключить перевод".
void setReqKey( bool vl ); — Установка признака "Ключ запроса".
void setExtVal( bool vw ); — Установка признака "Расширенное значение".
TFld &fld( ) const; — Конфигурация ячейки.
string getSEL( ); — Получить значение выборочного типа.
string getS( ) const; string getS( uint8_t RqFlg ); — Получить значение строкового типа с флагами запроса RqFlg.
const char *getSd( ); — Получить прямой доступ к значению строкового типа, только для чтения.
double &getRd( ); — Получить прямой доступ к значению вещественного типа.
int64_t &getId( ); — Получить прямой доступ к значению целого типа.
char &getBd( ); — Получить прямой доступ к значению логического типа.
void setSEL( const string &val, uint8_t RqFlg = 0 ); — Установить значение выборочного типа в val с флагами запроса RqFlg.
void setS( const string &val ); TCfg &operator=( const string &vl ); TCfg &operator=( const char *vl ); void setS( const string &val, uint8_t RqFlg ); — Установить значение строкового типа в val с флагами запроса RqFlg.
void setR( double val ); TCfg &operator=( double vl ); void setR( double val, uint8_t RqFlg ); — Установить значение вещественного типа в val с флагами запроса RqFlg.
void setI( int64_t val ); TCfg &operator=( int64_t vl ); void setI( int64_t val, uint8_t RqFlg ); — Установить значение целого типа в val с флагами запроса RqFlg.
void setB( char val ); TCfg &operator=( bool vl ); void setB( char val, uint8_t RqFlg ); — Установить значение логического типа в val с флагами запроса RqFlg.
TConfig &owner( ) const; — Объект контейнера-владельца.

13.3. Объект структуры данных (TElem)

Наследуется:

TTypeParam, TControllerS, TTypeDAQ, а также модульными объектами, совмещающими функции хранения структуры.

Публичные методы:

TElem( const string &name = "" ); — Инициализация структуры с указанным именем name.
TElem( const TElem &src ); — Копирующий конструктор.
TElem &operator=( const TElem &src ); — Копирование из src
string &elName( ); — Имя структуры.
void fldList( vector<string> &list ); — Список ячеек в структуре list.
unsigned fldSize( ); — Количество ячеек в структуре.
unsigned fldId( const string &name, bool noex = false); — Получение индекса ячейки по её идентификатору name. В случае установки noex, при отсутствии ячейки будет возвращаться общее количество ячеек, а не осуществляться генерация исключения.
bool fldPresent( const string &name ); — Проверка на наличие указанной ячейки name.
int fldAdd( TFld *fld, int id = -1 ); — Добавление/вставка ячейки fld в позицию id (-1 — вставка в конец).
void fldDel( unsigned int id ); — Удаление ячейки id.
TFld &fldAt( unsigned int id ); — Получение ячейки id.
void fldClear( ); — Удаление всех ячеек.
void valAtt( TValElem *cnt ); — Вызывается автоматически в случае подключения структуры к хранилищу данных cnt.
void valDet( TValElem *cnt ); — Вызывается автоматически в случае отключения структуры от хранилища данных cnt.
ResMtx &resEl( ); — Мютекс для доступа к контейнерам полей.

13.4. Ячейка структуры данных (TFld)

Данные:
Тип ячейки (enum – TFld::Type):

TFld::Boolean(0) — логический тип;
TFld::Integer(1) — целочисленный тип;
TFld::Real(4) — вещественный тип;
TFld::String(5) — строковый тип;
TFld::Object(6) — объектный тип;
TFld::GenMask(0x0F) — маска основных типов;
TFld::Int16(0x11) — целое знаковое 16 разрядов;
TFld::Int32(0x01) — целое знаковое 32 разрядов;
TFld::Int64(0x21) — целое знаковое 64 разрядов;
TFld::Float(0x14) — float (4 байта);
TFld::Double(0x04) — double (8 байт).

Флаги ячейки (enum — TFld::AttrFlg):

TFld::NoFlag(0x00) — флаги отсутствуют;
TFld::Selected(0x01) — режим выборки из доступных значений, выборочный тип;
TFld::SelfFld(0x02) — создавать собственную копию этой ячейки;
TFld::NoWrite(0x04) — недоступна для записи;
TFld::HexDec(0x08) — целый тип: шестнадцатеричное представление;
TFld::OctDec(0x10) — целый тип: восьмеричное представление;
TFld::DateTimeDec(0x20) — целый тип: содержит дату в UTC;
TFld::FullText(0x08) — полнотекстовый, многострочный, режим тестового типа;
TFld::TransltText(0x10) — переводить текстовые переменные записи.

Публичные методы:

TFld( ); — Инициализация по умолчанию.
TFld( const TFld &ifld, const char *name = NULL ); — Копирующий конструктор, с возможностью индивидуальной установки имени name.
TFld( const char *name, const char *descr, Type type, unsigned char flg, const char *valLen = "", const char *valDef = "", const char *vals = "", const char *nSel = "", const char *res = "" ); — Инициализация с указанной конфигурацией.
TFld &operator=( const TFld &fld ); — Копирование ячейки из fld.
const string &name( ) const; — Имя ячейки.
const string &descr( ) const; — Описание ячейки.
int len( ) const; — Размер значения ячейки (символов в символьном представлении).
int dec( ) const; — Размер дробной части для вещественного (символов в символьном представлении).
Type type( ) const; — Тип ячейки.
static Type type(IO::Type tp); — Тип ячейки из IO::Type типа.
IO::Type typeIO( ) const; — Тип ячейки в IO::Type.
unsigned flg( ) const; — Флаги ячейки.
const string &def( ) const; — Значение по умолчанию.
string values( ) const; — Рабочий диапазон значения или перечень возможных значений для выборочного типа (в виде — "vl1;vl2;vl3").
string selNames( ) const; — Перечень имён значений для выборочного типа (в виде — "Value 1;Value 2;Value 3").
const string &reserve( ) const; — Резервный параметр.
void setDescr( const string &dscr ); — Установка описания в dscr.
void setLen( int vl ); — Установка размера ячейки в vl.
void setDec( int vl ); — Установка дробной части для вещественного, в vl.
void setDef( const string &def ); — Установка значения по умолчанию в def.
void setFlg( unsigned flg ); — Установка флагов в flg.
void setValues( const string &vls ); — Установка рабочего диапазона значения или перечня возможных значений для выборочного типа (в виде — "vl1;vl2;vl3") в vls.
void setSelNames( const string &slnms ); — Установка перечня имён значений для выборочного типа (в виде — "Value 1;Value 2;Value 3") в slnms.
void setReserve( const string &ires ); — Установка резервного параметра в res.
const vector<string> &selValS() const; — Список вариантов значений для строкового типа.
const vector<int> &selValI() const; — Список вариантов значений для целого типа.
const vector<double> &selValR() const; — Список вариантов значений для вещественного типа.
const vector<bool> &selValB() const; — Список вариантов значений для логического типа.
const vector<string> &selNm() const; — Список имён вариантов значений.
string selVl2Nm( const string &val ); — Получить выбранное имя по значению val строкового типа.
string selVl2Nm( int64_t val ); — Получить выбранное имя по значению целого val типа.
string selVl2Nm( double val ); — Получить выбранное имя по значению val вещественного типа.
string selVl2Nm( bool val ); string selVl2Nm( char val ); — Получить выбранное имя по значению val логического типа.
string selNm2VlS( const string &name ); — Получить значение строкового типа по выбранному имени name.
int64_t selNm2VlI( const string &name ); — Получить значение целого типа по выбранному имени name.
double selNm2VlR( const string &name ); — Получить значение вещественного типа по выбранному имени name.
bool selNm2VlB( const string &name ); — Получить значение логического типа по выбранному имени name.
XMLNode *cntrCmdMake( XMLNode *opt, const string &path, int pos, const string &user = "root", const string &grp = "root", int perm = 0664 ); — Создать элемент формы в соответствии с параметрами ячейки.

13.5. Объект упреждения про смену структуры (TValElem)

Наследуется:

TValue, TConfig.

Защищённые методы:

virtual void detElem( TElem *el ); — Уведомление элементом el контейнера про желание отключиться.
virtual void addFld( TElem *el, unsigned id ) = 0; — Уведомление про добавление ячейки id елемента el.
virtual void delFld( TElem *el, unsigned id ) = 0; — Уведомление про удаление ячейки id елемента el.

13.6. Ячейка данных (TVariant)

Данные:
Значения ошибки для различных типов данных (define):

EVAL_BOOL — Значение ошибки логического (2);
EVAL_INT — Значение ошибки целого (-2147483647);
EVAL_REAL — Значение ошибки вещественного (-3.3E308);
EVAL_STR — Значение ошибки строкового ("<EVAL>");
EVAL_INT16 — Значение ошибки целого 16 (-32767);
EVAL_INT32 — Значение ошибки целого 32 (-2147483647);
EVAL_INT64 — Значение ошибки целого 64 (-9223372036854775807ll);
EVAL_RFlt — Значение ошибки вещественного Float (-3.29E38);
EVAL_RDbl — Значение ошибки вещественного Double (-1.79E308).

Типы данных (enum — TVariant::Type):

TVariant::Null — тип данных и данные не установлены.
TVariant::Boolean — логический тип (boolean, 8бит).
TVariant::Integer — целочисленный тип (integer, 32бит).
TVariant::Real — вещественный тип (double).
TVariant::String — строка.
TVariant::Object — объект.

Публичные методы:

TVariant( ); — Конструктор по умолчанию.
TVariant( char ivl ); TVariant( bool ivl ); — Конструктор для логического типа.
TVariant( int64_t ivl ); TVariant( int ivl ); — Конструктор для целого типа.
TVariant( double ivl ); — Конструктор для вещественного типа.
TVariant( string ivl ); — Конструктор для строки.
TVariant( const char *var ); — Конструктор для строки.
TVariant( AutoHD<TVarObj> ivl ); TVariant( TVarObj *ivl ); — Конструктор для объекта.
TVariant( const TVariant &var ); — Копирующий конструктор.
bool operator==( const TVariant &vr ) const; — Сравнение объекта на равенство.
bool operator!=( const TVariant &vr ) const; — Сравнение объекта на неравенство.
TVariant &operator=( const TVariant &vr ); — Копирование объекта.
bool isNull( ) const; — Признак того, что объект не инициирован.
bool isEVal( ) const; — Признак того, что содержится ошибочное значение.
Type type( ) const; — Тип значения.
void setType( Type tp, bool fix = false, bool stdStringOmit = false ); — Установка типа tp для его фисации fix и возможности использования как постоянная stdStringOmit.
bool isModify( ); — Флаг модификации. Служит в объектных функциях для индикации модификации переменных.
void setModify( bool vl = true ); — Установка флага модификации.
virtual char getB( ) const; operator char( ); — Получение значения как логическое.
virtual int64_t getI( ) const; operator int64_t( ); operator int( ); — Получение значения как целого.
virtual double getR( ) const; operator double( ); — Получение значения как вещественного.
virtual string getS( ) const; operator string( ); — Получение значения как строки.
virtual AutoHD<TVarObj> getO( ) const; operator AutoHD<TVarObj>( ); — Получение объекта.
virtual void setB( char val ); — Установка в значение логического.
virtual void setI( int64_t val ); — Установка в значение целого.
virtual void setR( double val ); — Установка в значение вещественного.
virtual void setS( const string &val ); — Установка в значение строки.
virtual void setO( AutoHD<TVarObj> val ); — Установка объекта.

13.7. Пользовательский объект (TVarObj)

Наследуется:

TArrayObj

Публичные методы:

TVarObj( ); — Конструктор.
int connect( ); — Подключение к объекту.
int disconnect( ); — Отключение от объекта.
virtual void propList( vector<string> &ls ); — Список свойств ls объекта.
virtual TVariant propGet( const string &id ); — Запрос свойства объекта с идентификатором id.
TVariant propGet( const string &ids, char sep ); — Запрос иерархического свойства объекта с путём ids и разделителем sep.
virtual void propSet( const string &id, TVariant val ); — Установка свойства объекта с идентификатором id в значение val.
void propSet( const string &ids, char sep, TVariant val ); — Установка иерархического свойства объекта с путём ids и разделителем sep в значение val.
void propClear( const string &ids = "" ); — Очистка свойства ids или всех свойств для пустого ids.
virtual string getStrXML( const string &oid = "" ); — Преобразование содержимого объекта в поток XML.
static AutoHD<TVarObj> parseStrXML( const string &str, XMLNode *nd = NULL, AutoHD<TVarObj> prev = NULL ); — Обратное преобразование XML-потока в объект.
virtual TVariant funcCall( const string &id, vector<TVariant> &prms ); — Вызов функции объекта с идентификатором id и параметрами prms.

14. Интерфейс управления системой и динамическое дерево объектов системы (TCntrNode)

Для полного покрытия ключевых компонентов системы сетью объектов единой структуры предназначен объект узла динамического дерева TCntrNode. На этот объект возлагаются следующие функции:

единообразного доступа к компонентам системы, включая блокировки динамического доступа;
построение распределённого интерфейса управления.

Любой объект, имеющий потребность в предоставлении динамического доступа к себе или своим компонентам должен наследоваться от объекта узла динамического дерева TCntrNode. Данное родство автоматически включает узел в динамическое дерево объектов, охваченное как прямой, так и обратной связью, а также предоставляет возможность создания контейнеров под собственные дочерние узлы. В дополнении к этому узел получает возможность упреждения про включение и исключение/удаление узла из дерева с возможностью отказа от исключения/удаления.

Интерфейс управления системы включён в состав объекта TCntrNode и, соответственно, охватывает все узлы динамического дерева системы, позволяя единообразно управлять системой вне зависимости от используемого клиентского инструмента. Интерфейс управления системой выполнен на основе языка разметки XML. Можно придумать множество способов использования интерфейса управления системой, в качестве примера отметим следующие наиболее яркие решения:

Web интерфейс конфигурации;
GUI интерфейс конфигурации (QT, GTK+, ...);
отражение конфигурации в сеть для распределённого управления множеством из единой среды администрирования;
использование в роли протокола для доступа к данным объектов из сети;
предоставление сервисных функций для доступа третьих приложений и отдельных компонентов OpenSCADA к внутренним данным.

Интерфейс управления системой реализован посредством составляющих:

информационной структуры конфигурационной пользовательской страницы;
динамической части в виде запросов на получение, модификацию данных и сервисных запросов;
контейнера или группы вышеуказанных элементов.

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

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

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

Общий интерфейс управления строится из отдельных узлов динамического дерева. Иерархическое наследование от объекта TCntrNode позволяет реализовывать многоуровневое дополнение конфигурации интерфейса управления. Общий вид динамического дерева узлов представлен на рис. 8.

Пример динамического дерева узлов системы OpenSCADA. (120 Кб)

Рис. 8. Пример динамического дерева узлов системы OpenSCADA.

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

Подключение узла в динамическое дерево производится следующим образом:

наследование объекта TCntrNode или его потомка;
формирование информационной структуры;
обслуживание запросов к динамическим данным.

14.1. Синтаксис запроса и ответа интерфейса управления

Весь обмен с интерфейсом управления производится посредством языка XML. При этом внутренний обмен выполняется разобранной структурой языка XML (DOM), а внешний — посредством преобразования в поток символов сплошного XML-файла и обратно.

Запрос выполняется посредством отправки одного контейнера с некоторыми параметрами в атрибутах. Результат помещается в полученный контейнер с изменением некоторых атрибутов корневого контейнера. В общем виде контейнер запроса можно записать следующим образом:
<cmd path="/TreePath" user="user" force="1"/>
Где:

cmd — команда запроса;
path — путь к узлу или ветви узла;
user — пользователь системы от имени которого направлен запрос;
force — признак выполнить запрос без предупреждения.

В подтверждение результата запроса устанавливается атрибут результата rez в значения: 0-запрос прошел, 1-предупреждение (с возможностью выполнения), 2-ошибка. В случае ошибки и предупреждения сообщения записываются в текст контейнера и атрибут mcat (категория сообщения): <cmd path="/TreePath" user="user" force="1" rez="2" mcat="sub_DAQ/mod_BlockCalc>Невозможно удалить узел</cmd>.

Группирующий запрос "CntrReqs" обрабатываются на уровне API узла и не требуют отдельной обработки в пользовательском коде. Фактически в тег "CntrReqs" могут помещаться любые другие запросы с возможностью иерархической группировки путём включения внутренних тегов "CntrReqs". Единственным атрибутом этого тега является атрибут path, который указывает путь к узлу и является основой для внутренних запросов.


<CntrReqs path="/sub_DAQ/cntr_gate">
  <get path="/%2fprm%2fcfg%2fNAME"/>
  <get path="/%2fprm%2fcfg%2fDESCR"/>
  <list path="/%2fserv%2fattr"/>
</CntrReqs>

14.2. Тег информационной структуры для описания групп дочерних веток страницы

Каждая страница может содержать группы дочерних ветвей. Для описания групп ветвей предусмотрен тег branches. Тег содержит описание групп ветвей посредством вложенных тегов grp. К тегу группы возможен доступ как на "чтение" (видимость) так и на модификацию (выполнение команд добавления и удаления элементов группы), следовательно элемент триады доступа может принимать значения:

00 — доступ вообще отсутствует;
04 — присутствует доступ только на чтение;
02 — присутствует доступ только на запись, обычно такое значение не имеет смысла поскольку доступ на запись подразумевает и доступ на чтение;
06 — присутствует доступ и на чтение, и на запись.

Действия над группой элементов полностью совпадают с действиями над списком визуальных элементов "list", о котором написано ниже.

14.3. Теги описания информационной структуры интерфейса управления

Информационные теги для языка XML составляют алфавит формирования описания конфигурационных диалогов. Команда запроса информационной части имеет вид: <info path="/TreePath" user="user"/>

В результате запроса будет получена информационная структура страницы в соответствии с привилегиями указанного пользователя.

14.3.1. Тег области "area"

Области описываются тегом area и предназначены для группировки элементов по различным признакам. Область может включать другие элементы и области. Корневые области формируют закладки в представлении пользовательского интерфейса. К тегу возможен доступ только на "чтение" или "видимость", следовательно элемент триады доступа может принимать значение 00, если доступ отсутствует, или 04, если присутствует.


<area id='base' dscr='Base information'>
  <fld id='host' dscr='Host name' tp='str'/>
  <fld id='user' dscr='Operated user' tp='str'/>
  <fld id='sys' dscr='Station system' tp='str'/>
  <area id='other' dscr='Other options'>
     <fld id='val' dscr='Value' tp='real'/>
  </area>
</area>

14.3.2. Теги данных

Теги, описывающие данные, сведены в таблице 1.

Таблица 1. Теги, описывающие данные

Тег	Описание
<fld>	Простейшие данные строкового, целого, вещественного и логического типов.
<list>	Списки с данными строкового, целого, вещественного и логического типов.
<table>	Таблицы с данными в ячейках строкового, целого, вещественного и логического типов.
<img>	Изображения.

a) Тег "fld"


<fld id='host' dscr='Host name' tp='str'/>
<fld id='user' dscr='Operated user' tp='str'/>
<fld id='sys' dscr='Station system' tp='str'/>

К тегу возможен доступ как на "чтение", так и на "запись", следовательно элемент триады доступа может принимать значения:

Тип элемента, описываемого тегом "fld", указывается атрибутом tp (таблица 2).

Таблица 2. Значения атрибута tp тега "fld".

Тег tp	Описание
str	Строковый тип. <fld id='host' dscr='Host name' tp='str'/>
dec	Целое число в десятичном представлении. <fld id='debug' dscr='Debug level' tp='dec'/>
oct	Целое число в восьмеричном представлении. <fld id='cr_file_perm' dscr='Make files permissions(default 0644)' tp='oct' len='3'/>
hex	Целое число в шестнадцатеричном представлении.
real	Вещественное число.
bool	Логический признак ("false"\|"true"). <fld id='log_sysl' dscr='Direct messages to syslog' tp='bool'/>
time	Время в секундах (от 01/01/1970). <fld id='v_beg' dscr='Start time' tp='time'/>

Таблица 3. Действия над элементом, описанным тегом "fld".

Операция	Действие
Опрос	Запрос: команда "get": <get path="/fld_teg" user="user"/>. Результат: подтверждение со значением в тексте тега или сообщение об ошибке.
Модификация	Запрос: команда "set": <set path="/fld_teg" user="user">value</set> Результат: подтверждение или сообщение об ошибке.
Запрос правил подсветки синтаксиса, для текстовых полей (определён атрибут "rows").	Запрос: команда "SnthHgl": <SnthHgl path="/fld_teg" user="user"/> Результат: подтверждение со списком правил подсветки синтаксиса: `<rule expr="\b(if\|else\|for\|while\|in\|using\|new\|var\|break\|continue\|return\|Array\|Object)\b" color="darkblue" font_weight="1"/> <rule expr="(\?\|\:)" color="darkblue" font_weight="1"/> <rule expr="(\b0[xX][0-9a-fA-F]\b\|\b[+-]?[0-9]\.?[0-9]+[eE]?[-+]?[0-9]\b\|\btrue\b\|\bfalse\b)" color="blue"/> <rule expr=""[^"]"" color="darkgreen"/> <rule expr="//[^\n]" color="gray" font_italic="1"/> <blk beg="/\\" end="\\*/" color="gray" font_italic="1"/>`

b) Тег "list"


<list id='mod_auto' dscr='List of shared libs(modules)' tp='str' dest='file'/>

К тегу возможен доступ как на "чтение", так и на "запись"(модификацию), следовательно элемент триады доступа может принимать значения:

Тип элементов в списке указывается атрибутом tp. Значения атрибута tp приведены в таблице 1.

Таблица 4. Действия над списком.

Операция	Действие
Опрос	Запрос: команда "get": <get path="/fld_teg" user="user"/> Результат: подтверждение с результатом в тексте тега или сообщение об ошибке. Результат формируется в виде: <get path="/fld_teg" user="user" rez="0"> <el id='0'>./MODULES/arh_base.o</el> <el id='1'>./MODULES/cntr_sys.o</el> </get>
Добавление строки	Запрос: команда "add": <add path="/fld_teg" user="user" id="tst">Test</add> Читается, как добавить строку с идентификатором "tst" и значением "Test". Если список не индексированный, то атрибут id отсутствует. Результат: подтверждение или сообщение об ошибке.
Вставка строки	Запрос: команда "ins": <ins path="/fld_teg" user="user" pos="3" p_id="tst1" id="tst">Test</ins> Читается, как вставить строку с идентификатором "tst" и значением "Test" в позицию 3 со строкой "tst1". В случае индексного списка атрибут p_id содержит идентификатор, иначе — текст строки. Если список не индексирован, то атрибут id отсутствует. Результат: подтверждение или сообщение об ошибке.
Удаление строки	Запрос: команда "del": <del path="/fld_teg" user="user" pos='3' id='tst'>Test</del> Читается, как удалить строку с идентификатором "tst" и значением "Test" в позиции 3. Если список не индексирован, то атрибут id отсутствует. Результат: подтверждение или сообщение об ошибке.
Изменение строки	Запрос: команда "edit": <edit path="/fld_teg" user="user" pos='3' p_id='tst1' id='tst' >Test</edit> Читается, как заменить строку в позиции 3 с идентификатором "tst1" на строку с идентификатором "tst" и значением "Test". В случае индексированного списка атрибут p_id содержит идентификатор, иначе — текст строки. Если список не индексирован, то атрибут id отсутствует. Результат: подтверждение или сообщение об ошибке.
Перемещение строки	Запрос: команда "move": <move path="/fld_teg" user="user" pos='3' to='5'/> Читается, как переместить строку с позиции 3 в позицию 5. Результат: подтверждение или сообщение об ошибке.

c) Тег "table"


<table id='a_mess' key='0' col_lst="0;1;2">
  <list id='0' dscr='Id' acs='4' tp='str'/>
  <list id='1' dscr='Name' acs='4' tp='str'/>
  <list id='2' dscr='Type' acs='4' tp='str'/>
  <list id='3' dscr='Hide' acs='4' tp='bool'/>
</table>

К тегу таблицы и колонкам отдельно возможен доступ как на "чтение", так и на "запись"(модификацию), следовательно элемент триады доступа может принимать значения:

Если указан атрибут key и в нём перечислены ключевые колонки, то работа с таблицей переходит в режим адресации по идентификаторам колонок и ключам.

Таблица 5. Действия над таблицей.

Операция	Действие
Опрос	Запрос: команда "get": <get path="/fld_teg" user="user" cols="0;2" rows="100;1000"/> Читается, как получить колонки 0-2 и строки в них с 100 по 1000 таблицы. Результат: Подтверждение с данными таблицы или сообщение об ошибке. Результат формируется в виде: <get path="/fld_teg" user="user" cols="0;2" rows="100;1000" rez="0"> <list id='0' tp='str'> <el id='100'>Sat Feb 21 18:04:16 2004</el> </list> <list id='1' tp='str'> <el id='100'>SYS</el> </list> <list id='2' tp='str'> <el id='100'>*:(TSYS)Broken PIPE signal allow!</el> </list> </get>
Добавление строки	Запрос: команда "add": <add path="/fld_teg" user="user"/> Результат: подтверждение или сообщение об ошибке.
Вставка строки	Запрос: команда "ins": <ins path="/fld_teg" user="user" row='3'/> Читается, как вставить строку в позицию 3. Команда не работает при установленном атрибуте key! Результат: подтверждение или сообщение об ошибке.
Удаление строки	Запрос: команда "del": <del path="/fld_teg" user="user" row='3'/> или <del path="/fld_teg" user="user" key_id='Test'/> для ключевого режима Читается, как удалить строку в позиции 3 или строку в позиции, где значение колонки id равно 'Test'. Результат: подтверждение или сообщение об ошибке.
Перемещение строки	Запрос: команда "move": <move path="/fld_teg" user="user" row='3' to='5'/> Читается, как переместить строку с позиции 3 в позицию 5. Данная команда не работает при установленном атрибуте key! Результат: подтверждение или сообщение об ошибке.
Изменить ячейку	Запрос: команда "set": <set path="/fld_teg" user="user" row='3' col='id'>Test</set> или <set path="/fld_teg" user="user" key_id='Test' col='id'>Test1</set> для ключевого режима Читается как — установить значение ячейки в строке 3 и колонке 'id' в "Test" или установка колонки с именем 'id' строки в позиции где значение колонки id равно 'Test' в значение 'Test1'. Практически данная команда переименовывает ключевой элемент указанной строки. Результат: подтверждение или сообщение об ошибке.

d) Тег "img"


<img id='ico' descr='Иконка страницы'/>

Тег предназначен для передачи изображений клиентам интерфейса управления. Под изображением могут выступать: иконки страниц, графики массивов значений и другие данные, которые можно представить в графическом виде.

Поддерживаются команды запросов:

<get path="/fld_teg" user="user"/> — запрос изображения;

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

<set path="/fld_teg" user="user">img</set> — загрузка изображения.

Результатом является подтверждение или сообщение об ошибке.

e) Команды с параметрами. Тег "comm"


<comm id='add'>
  <fld id='tm' tp='time'/>
  <fld id='cat' tp='str'/>
  <fld id='lvl' tp='dec' min='0' max='7'/>
  <fld id='mess' tp='str'/>
</comm>

К тегу возможен доступ как на "чтение" или видимость+обслуживание запросов, так и на модификацию или выполнение команды, следовательно элемент триады доступа может принимать значение 00, если доступ отсутствует вообще; 04, если команду можно увидеть; и 06, если команду можно инициировать.

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

Поддерживаются команды запросов:

Вызов команды:


<set path="/fld_teg" user="user"/>
  <fld id='tm'>1023456244</fld>
  <fld id='cat'>*</fld>
  <fld id='lvl'>2</fld>
  <fld id='mess'>Test mess</fld>
</set>

Загрузка ссылки на другую страницу:


<get path="/fld_teg" user="user" tp="lnk"/>"

Результатом является подтверждение или сообщение об ошибке.

f) Ветки (дочерние узлы)


<list id='k_br' dscr='Kernel branches' tp='br'/>

Ветки описываются обычным списком "list" со специальными атрибутами tp='br'. Методика запроса и модификации веток полностью совпадает с методикой работы со списком "list".

14.4 Иерархические зависимости информационных элементов языка управления

Пример страницы узла языка управления:


<oscada_cntr>
  <area id='a_gen' dscr='Generic control'>
    <fld id='config' dscr='Config file' tp='str' dest='file'/>
    <fld id='cr_file_perm' dscr='Files' tp='oct' len='3'/>
    <fld id='cr_dir_perm' dscr='Directories' tp='oct' len='3'/>
    <comm id='upd_opt' dscr='Update options(from config)'/>
    <comm id='quit' dscr='Quit'/>
  </area>
  <area id='a_kern' dscr='Kernels'>
    <list id='k_br' dscr='Kernels' tp='br'/>
  </area>
</oscada_cntr>

Таблица 6. Иерархические зависимости информационных элементов языка:

Тег	Описание	Атрибуты	Содержимое
oscada_cntr	Корневой элемент страницы. Является единственным и служит для идентификации принадлежности к языку интерфейса управления.	id — идентификатор; dscr — описание.	area, img, branches
branches	Контейнер групп дочерних веток узла.	id — идентификатор контейнера. Равен: br.	grp
grp	Группа дочерних узлов.	id — префикс группы дочерних узлов в системе; dscr — описание группы веток; acs — опции доступа.
area	Группировка стандартных тегов.	id — идентификатор; dscr — описание; acs — опции доступа.	area, fld, list, table, comm, img
comm	Команды узлу.	id — идентификатор; dscr — описание; help — помощь по команде; tp — тип команды (lnk — ссылка); acs — опции доступа.	fld
fld	Описание данных стандартных типов.	id — идентификатор; dscr — описание; help — помощь; acs — опции доступа. tp — тип элемента: str(len, dest, cols, rows(SnthHgl)) — строковый элемент; dec(len, max, min, dest) — целое число в десятичном представлении; oct(len, max, min, dest) — целое число в восьмеричном представлении; hex(len, max, min, dest) — целое число в шестнадцатеричном; real(len, max, min, dest) — вещественное число; bool — логический признак; time — время/дата в секундах (от 01/01/1970). Связные: len — длина значения (симв.); min — минимум значения; max — максимум значения; cols — количество колонок; rows — количество строк; dest — способ ввода: data — источник бинарных данных (base64). select(select) — выборный тип; sel_ed(select) — выборный тип с возможностью редактирования. select — путь к скрытому списку; sel_list — статический список (разделитель ';'); sel_id — статический список идентификаторов (разделитель ';').
list	Список данных стандартных типов.	id — идентификатор; dscr — описание; help — помощь по списку; acs — опции доступа. tp — как в fld кроме: br(br_pref) — дочерние узлы. idm — индексированный список (0\|1); s_com — способы модификации списка [add][,ins][,edit][,del]: add — добавлять строки; ins — вставлять строки; edit — модифицировать строки; del — удалять строки. Связные: br_pref — префикс дочерних узлов; dest — как в fld.
table	Таблица данных стандартных типов.	id — идентификатор; dscr — описание; help — помощь по таблице; acs — опции доступа; key — ключевые колонки (key="id,name,per"); cols — перечень колонок в атрибуте запроса; rows — диапазон строк в атрибуте запроса; s_com — способы модификации таблицы [add][,del][,ins][,move]: add — добавлять строки; ins — вставлять строки; del — удалять строки; move — перемещать строки.	list
img	Изображение.	id — идентификатор; dscr — описание; help — помощь по изображению; acs — опции доступа; h_sz — горизонтальное ограничение; v_sz — вертикальное ограничение.

14.5. Объект узла динамического дерева (TCntrNode)

Наследуется:

Всеми динамическими и управляемыми объектами прямо или через потомков.

Данные:
Именованные права доступа к элементам управления (define):

R_R_R_ (0444) — доступ всем только на чтение;
R_R___ (0440) — доступ на чтение только владельцу и группе;
R_____ (0400) — доступ на чтение только владельцу;
RWRWRW (0666) — полный доступ для всех;
RWRWR_ (0664) — полный доступ владельцу и группе, а всем остальным только на чтение;
RWR_R_ (0644) — полный доступ владельцу, а группе и всем остальным только на чтение;
RWR___ (0640) — полный доступ владельцу, только на чтение - группе и закрыт всем остальным;
RW____ (0600) — полный доступ владельцу, а группе и всем остальным закрыт.

Флаги динамического узла (enum TCntrNode::Flag):

TCntrNode::DoDisable — отключение (0);
TCntrNode::Disabled — отключен (1);
TCntrNode::DoEnable — включение (2);
TCntrNode::Enabled — включен (3);
TCntrNode::SelfModify — признак модификации узла (0x04);
TCntrNode::SelfModifyS — признак сохранения модификации узла в "load_()" (0x08);
TCntrNode::SelfSaveForceOnChild — принудительно сохранять, вызывать "save_()", если изменены-сохраняются дочерние узлы (0x10).

Флаги режимов включения/отключения узла (enum TCntrNode::Flag):

TCntrNode::NodeConnect — подключение узла;
TCntrNode::NodeRestore — восстановление подключения узла.

Флаги модификации узла (enum TCntrNode::ModifFlag):

TCntrNode::Self — данный узел модифицирован;
TCntrNode::Child — модифицированы дочерние узлы;
TCntrNode::All — модифицирован данный узел и дочерние.

Публичные методы:

TCntrNode( TCntrNode *prev = NULL ); — Инициализация с указанием родительского узла prev.
virtual string objName( ); — Имя объекта. Объект-наследник должен доопределить суммарное имя объекта.
virtual TCntrNode &operator=( const TCntrNode &node ); — Виртуальная функция копирования узлов динамического дерева.
void cntrCmd( XMLNode *opt, int lev = 0, const string &path = "", int off = 0 ); — Команда работы с интерфейсом управления системы. Поддерживаются транспортные переходы по полному пути вида: где %2fgen закодированный вложенный путь к конкретному полю страницы (/gen).
static XMLNode *ctrId( XMLNode *inf, const string &n_id, bool noex = false ); — Получение узла XML по значению атрибута 'id' n_id. Поддерживаются запросы XML узла по полному пути к нему вида (node1/node2/node3).
static XMLNode *_ctrMkNode( const char *n_nd, XMLNode *nd, int pos, const char *req, const string &dscr, int perm = 0777, const char *user = "root", const char *grp = "root" );

static XMLNode *ctrMkNode( const char *n_nd, XMLNode *nd, int pos, const char *req, const string &dscr int perm = 0777, const char *user = "root", const char *grp = "root", int n_attr = 0, ... );
static XMLNode *ctrMkNode2( const char *n_nd, XMLNode *nd, int pos, const char *req, const string &dscr, int perm = 0777, const char *user = "root", const char *grp = "root", ... );
— Добавление элемента управления на страницу. Возможно указание множества дополнительных атрибутов в количестве n_attr в виде: "{атрибут1},{значений1},{атрибут2},{значений2},..." или по нулевому указателю в конце последовательности пар.

bool ctrRemoveNode( XMLNode *nd, const char *path ); — Удаление элемента управления path на странице nd.
static bool ctrChkNode( XMLNode *nd, const char *cmd="get", int perm=0444, const char *user="root", const char *grp="root", char mode=04, const char *warn = NULL ); — Проверка на получение динамической команды cmd и наличие прав на её исполнение.
ResMtx &dataRes( ); — Мютекс использования ресурсов узла общего назначения.
virtual const char *nodeName( ) const; — Имя узла.
virtual const char *nodeNameSYSM( ) const; — Имя элемента расположения системного сообщения, для помещения его в текст системного сообщения функцией "mess_sys" и "err_sys". Пустое значение, по умолчанию, для пропуска данного узла.
string nodePath( char sep = 0, bool from_root = true ) const; — Получение полного пути к узлу, начиная с корня from_root, и используя разделитель sep или обычную запись пути.
void nodeList( vector<string> &list, const string& gid = "" ); — Список дочерних узлов list в указанной группе gid.
AutoHD<TCntrNode> nodeAt( const string &path, int lev = 0, char sep = 0, int off = 0, bool noex = false ); — Подключение к дочернему узлу.
void nodeDel( const string &path, char sep = 0, int flag = 0 ); — Удаление узла по его полному пути.
static void nodeCopy( const string &src, const string &dst, const string &user = "root" ); — Копирование узлов динамического дерева.
TCntrNode *nodePrev( bool noex = false ) const; — Адрес родительского узла.
char nodeFlg( ); — Флаги узла.
void setNodeFlg( char flg ); — Установка флагов TCntrNode::SelfModify, TCntrNode::SelfModifyS и TCntrNode::SelfSaveForceOnChild.
char nodeMode( ) const; — Состояние узла.
unsigned nodeUse( bool selfOnly ); — Количество подключений к узлу. selfOnly — только собственных подключений, без дочерних.
unsigned nodePos( ); — Положение данного узла в контейнере узла-владельца. Достоверно только для упорядоченных контейнеров.
int isModify( int mflg = TCntrNode::All ); — Проверка факта модификации узла или ветви узлов.
void modif( bool save = false ); — Установка признака модифицированности узла, с признаком сохранения save.
void modifG( ); — Установка признака модифицированности ветви узлов.
void modifClr( bool save = false ); — Очистка признака модифицированности узла или признака сохранения save.
void modifGClr( ); — Очистка признака модифицированности ветви узлов.
void load( TConfig *cfg = NULL, string *errs = NULL ); — Загрузка узла динамического дерева для готовой конфигурации cfg. Ошибки загрузки помещаются строками в errs.
void save( unsigned lev = 0, string *errs = NULL ); — Сохранение узла динамического дерева, на уровне вложенности lev (служебный). Ошибки сохранения помещаются строками в errs.
virtual void AHDConnect( ); — Подключение к узлу (захват ресурса).
virtual bool AHDDisConnect( ); — Отключение от узла (освобождение ресурса). Удаление при нулевом результате.
void mess_sys( int8_t level, const char *fmt, ... ); — Формирование системного сообщения для пути узла в качестве категории, уровня level, форматированного сообщения fmt, дополненного расположением узла, и следующими аргументами.
TError err_sys( const char *fmt, ... ) const; TError err_sys( int cod, const char *fmt, ... ) const; — Формирование объекта ошибки для пути узла в качестве категории, кода cod, форматированного сообщения fmt, дополненного расположением узла, и следующими аргументами.
virtual TVariant objPropGet( const string &id ); — Запрос свойства узла как пользовательского объекта.
virtual void objPropSet( const string &id, TVariant val ); — Установка свойства узла как пользовательского объекта.
virtual TVariant objFuncCall( const string &id, vector<TVariant> &prms ); — Вызов функции узла как пользовательского объекта.
int8_t grpSize( ); — Количество контейнеров с дочерними узлами.
int8_t grpId( const string &sid ); — Получение индекса группы по её идентификатору.
virtual AutoHD<TCntrNode> chldAt( int8_t igr, const string &name, const string &user = "" ) const; — Подключение к дочернему узлу name контейнера gr пользователя user.
void chldList( int8_t igr, vector<string> &list, bool noex = false ) const; — Список дочерних узлов list в указанном контейнере gr.
bool chldPresent( int8_t igr, const string &name ) const; — Проверка на присутствие указанного дочернего узла name в контейнере gr.

Защищённые методы:

virtual void cntrCmdProc( XMLNode *req ); — Функция обслуживания запросов интерфейса управления. Должна переопределяться у потомка.
void nodeEn( int flag = 0 ); — Включение узла.
void nodeDis( long tm = 0, int flag = 0 ); — Отключение узла с передачей флага.
void nodeDelAll( ); — Очистка всех контейнеров с дочерними узлами.
void setNodePrev( TCntrNode *node ); — Установка родительского узла в node.
void setNodeMode( char mode ); — Установка состояния узла.
GrpEl &grpAt( int8_t id ); — Доступ к структуре группы.
unsigned grpAdd( const string &id, bool ordered = false ); — Добавление контейнера дочерних узлов с префиксом id и возможностью упорядоченного хранения ordered. Возвращает идентификатор нового контейнера.
void grpDel( int8_t id ); — Удаление контейнера дочерних узлов id.
virtual void chldAdd( int8_t igr, TCntrNode *node, int pos = -1 ); — Добавление дочернего узла node в контейнер gr и позицию pos.
void chldDel( int8_t igr, const string &name, long tm = -1, int flag = 0 ); — Удаление дочернего узла name из контейнера gr с флагом flag.
virtual void preEnable( int flag ); — Упреждение о подключении. Вызывается перед реальным подключением.
virtual void postEnable( int flag ); — Упреждение о подключении. Вызывается после реального подключения.
virtual void preDisable( int flag ); — Упреждение о отключении. Вызывается перед реальным отключением.
virtual void postDisable( int flag ); — Упреждение о отключении. Вызывается после реального отключения (перед удалением).
virtual void load_( ); virtual void load_( TConfig *cfg ); — Функция вызова загрузки узла у потомка для готовой конфигурации cfg.
virtual void save_( ); — Функция вызова сохранения узла у потомка.

15. XML в системе OpenSCADA (XMLNode)

XML в системе OpenSACDA представлен объектом XML-тега — XMLNode.

15.1. XML-тег (XMLNode)

Данные:
Опции загрузки XML-файла (enum — XMLNode::LoadFlgs):

XMLNode::LD_Full — полная загрузка XML;
XMLNode::LD_NoTxtSpcRemEnBeg — не удалять пробелы в начале и конце текста тега, для неполного режима.

Опции функции генерации XML-файла (enum — XMLNode::SaveView):

XMLNode::BrOpenPrev — вставлять конец строки перед тегом открытия;
XMLNode::BrOpenPast — вставлять конец строки после тега открытия;
XMLNode::BrClosePast — вставлять конец строки после тега закрытия;
XMLNode::BrTextPast — вставлять конец строки после текста тега;
XMLNode::BrSpecBlkPast — вставлять конец строки после вычислительной инструкции;
XMLNode::BrAllPast — вставлять конец строки после всех элементов;
XMLNode::XMLHeader — вставлять стандартный xml-заголовок;
XMLNode::Clean — очистка результата от комментариев и процедурных вставок;
XMLNode::XHTMLHeader — вставлять стандартный XHTML-заголовок;
XMLNode::MissTagEnc — пропускать кодирование имён тегов;
XMLNode::MissAttrEnc — пропускать кодирование имён атрибутов.

Публичные методы:

XMLNode( const string &name = "" ); — Инициализация тега с именем name.
XMLNode( const XMLNode &nd ); — Копирующий конструктор.
XMLNode &operator=( const XMLNode &prm ); — Копирование ветки XML-дерева из prm.
string name( ) const; — Имя тега.
XMLNode* setName( const string &s ); — Установка имени тега в s.
string text( bool childs = false, bool recursive = false ) const; — Текст тега. childs — для получения текст из специализированных узлов текста.
XMLNode* setText( const string &s, bool childs = false ); — Установка текста тега в s. childs — для установки текста в специализированный узел текста.
void attrList( vector<string> & list ) const; — Список атрибутов list в теге.
XMLNode* attrDel( const string &name ); — Удаление атрибута name.
void attrClear( ); — Очистка атрибутов тега.
string attr( const string &name, bool caseSens = true ) const; — Получение атрибута name.
XMLNode* setAttr( const string &name, const string &val ); — Установка/создание атрибута name со значением val.
void load( const string &vl, unsigned flg = 0, const string &cp = "UTF-8" ); — Загрузка/парсинг XML-файла, с кодировкой cp и флагами flg.
string save( unsigned flg = 0, const string &cp = "UTF-8" ) const; — Сохранение/создание XML-файла с параметрами форматирования flg и кодировкой cp.
XMLNode* clear( ); — Очистка тега (рекурсивно, включая все вложения).
bool childEmpty( ) const; — Проверка на отсутствие вложенных тегов.
unsigned childSize( ) const; — Количество вложенных тегов.
void childAdd( XMLNode *nd ); — Добавление вложенного тега.
XMLNode* childAdd( const string &name = "" ); — Добавление вложенного тега.
int childIns( int id, XMLNode *nd ); — Вставка вложенного тега в позицию id. Отрицательный id отсчитывает с конца.
XMLNode* childIns( int id, const string &name = "" ); — Вставка вложенного тега с именем name в позицию id. Отрицательный id отсчитывает с конца.
void childDel( const int id ); — Удаление вложенного тега id. Отрицательный id отсчитывает с конца.
void childDel( XMLNode *nd ); — Удаление вложенного тега по его адресу nd.
void childClear( const string &name = "" ); — Очистка вложенного тега name.
XMLNode* childGet( const int, bool noex = false ) const; — Получение вложенного тега по порядковому номеру.
XMLNode* childGet( const string &name, const int numb = 0, bool noex = false ) const; — Получение вложенного numb порядкового тега по имени тега name. noex указывает на запрет генерации исключения в случае отсутствия тега.
XMLNode* childGet( const string &attr, const string &vl, bool noex = false ) const; — Получение вложенного numb порядкового тега по значению vl атрибута attr. noex указывает на запрет генерации исключения в случае отсутствия тега.
XMLNode* getElementBy( const string &attr, const string &val ); — Поиск вложенного узла по значению val атрибута attr.
void getElementsBy( const string &tag, const string &attr, const string &val, TArrayObj *rez ); — получение массива элементов в rez из дерева по тегу tag (пустой для всех) и атрибуту attr со значением val (пустые для пропуска).
XMLNode* parent( ); — Родительский тег данного тега.
XMLNode* root( ); — Корневой тег данного тега.

16. Ресурсы в системе OpenSCADA (Res, ResAlloc, ResMtx, MtxAlloc, AutoHD)

Большинство узлов и подсистем системы OpenSCADA являются динамическими, т.е. допускают создание/удаление/конфигурацию в процессе функционирования системы. Учитывая многопоточность системы, данная функциональность накладывает жесткие требования к синхронизации потоков. Для синхронизации в системе используются ресурсы, функции которых локализованы в объектах "Res" и "ResAlloc". Объект "Res" предоставляет хранилище ресурса, предусматривающего функции захвата/освобождения на чтение и запись. В объекте "ResAlloc" реализованы функции автоматического освобождения ресурса. Автоматический ресурс подразумевает создание локального объекта ресурса с автоматическим его освобождением при разрушении (в деструкторе). Использование автоматических ресурсов значительно упрощает работу с ресурсами при использовании исключений.

Любой динамический объект системы наследуется от объекта "TCntrNode", который содержит механизм подключения через шаблон "AutoHD". Основной функцией шаблона является хранение ссылки на объект и захват ресурса, исключающего удаление объекта на момент использования. Шаблон поддерживает копирование ресурса и автоматическое его освобождение в случае разрушения объекта шаблона. Для наглядности доступа к объектам порождённым от "TCntrNode" шаблон "AutoHD" поддерживает приведение типов, основанное на динамическом приведении.

16.1. Объект R/W ресурса (ResRW)

Публичные методы:

ResRW( ); — Инициализация ресурса.
static void resRequestW( long tm = 0 ); — Запрос ресурса на запись/модификацию с таймаутом ожидания tm (в миллисекундах).
bool resTryW( ); — Попытка захвата ресурса на запись/модификацию. При успешном захвате возвращает "true" иначе "false".
static void resRequestR( long tm = 0 ); — Запрос ресурса на чтение с таймаутом ожидания tm (в миллисекундах).
bool resTryR( ); — Попытка захвата ресурса на чтение. При успешном захвате возвращает "true" иначе "false".
static void resRelease( ); — Освобождение ресурса.

16.2. Объект автоматического освобождения R/W ресурса (ResAlloc)

Публичные методы:

ResAlloc( ResRW &rid ); — Инициализация автоматически освобождающегося ресурса для ранее выделенного идентификатора rid.
ResAlloc( ResRW &rid, bool write, long tm = 0 ); — Инициализация автоматически освобождающегося ресурса для ранее выделенного идентификатора rid. С указанием типа ресурса write (чтение/запись).
void request( bool write = false, long tm = 0 ); void lock( bool write = false, unsigned short tm = 0 ); — Запрос ресурса в указанном режиме write (чтение/запись).
void release( ); void unlock( ); — Освобождение ресурса.

16.3. Шаблон (AutoHD)

Публичные методы:

AutoHD( ); — Инициализация без привязки к объекту.
AutoHD( ORes *node, const string &who = "" ); — Инициализация с привязкой к объекту node. Объект должен содержать функцию AHDConnect() и AHDDisConnect().
AutoHD( const AutoHD &hd ); — Копирующий конструктор.
template <class ORes1> AutoHD( const AutoHD<ORes1> &hd_s ); — Конструктор приведения типов в безопасном режиме приведения (посредством dynamic_cast). Возвращает свободный ресурс в случае невозможности приведения.
ORes &at( ) const; — Получение объекта за ресурсом.
AutoHD &operator=(const AutoHD &hd); — Копирование ресурсов.
bool operator==(const AutoHD &hd); — Сравнение объектов за ресурсом по указателю.
void free( ); — Освобождение ресурса.
bool freeStat( ) const; — Признак "Ресурс свободен".

16.4. Объект захвата ресурсов, мютексом (ResMtx)

Публичные методы:

ResMtx( bool isRecurs = false ); — Инициализация объекта мютекса с рекурсией isRecurs.
void lock( ); — Захват мютекса. Возврат нуля в случае успеха.
void unlock( ); — Освобождение мютекса. Возврат нуля в случае успеха.
int tryLock( ); — Проба захвата мютекса, без ожидания освобождения. Возврат нуля в случае успеха.
pthread_mutex_t &mtx( ); — Прямая ссылка на структуру мютекса.

16.5. Объект строки с доступом, разделённым ресурсом (ResString)

Публичные методы:

explicit ResString( const string &vl = "" ); — Инициализация строки с указанным значением vl.
ResString &operator=( const string &val ); — Функция неявного преобразования из std::string.
operator string( ); — Функция неявного преобразования в std::string.
size_t size( ); — Размер строки.
bool empty( ); — Строка пуста.
void setVal( const string &vl ); — Установка значения строки в vl.
const string &getVal( ); — Получение значения строки.
const string &getValRef( ); — Получение прямой ссылки на строку std::string. Ресурс игнорируется в случае использования этой функции!

16.6. Объект условной переменной, по мютексу (CondVar)

Публичные методы:

CondVar( ); — Инициализация условной переменной.
int wait( ResMtx &mtx, unsigned short tm = 0 ); — ожидание пробуждения по условной переменной с таймаутом tm и мютексом mtx.
int wakeOne( ); — пробуждение одного потока.
int wakeAll( ); — пробуждение всех потоков.

16.7. Объект автоматического освобождения POSIX мютекса (MtxAlloc)

Публичные методы:

MtxAlloc( ResMtx &iM, bool lock = false ); — Инициализация автоматически освобождающегося мютекса для ранее выделенного идентификатора iM. С указанием блокировки lock при создании.
int lock( ); — Захват ресурса. Возврат нуля при успешном выполнении.
int unlock( ); — Освобождение ресурса. Возврат нуля при успешном выполнении.
int tryLock( ); — Проба захвата ресурса, без ожидания освобождения. Возврат нуля при успешном выполнении.

16.8. Объект строки с доступом, разделённым глобальным ресурсом(мютексом) данных (MtxString)

Публичные методы:

MtxString( ResMtx &iM ); — Инициализация строки с разделением доступа ресурсом iM.
MtxString &operator=( const string &val ); — Функция неявного преобразования из std::string.
operator string( ); — Функция неявного преобразования в std::string.
size_t size( ); — Размер строки.
bool empty( ); — Строка пуста.
void setVal( const string &vl ); — Установка значения строки в vl.
const string &getVal( ); — Получение значения строки.
const string &getValRef( ); — Получение прямой ссылки на строку std::string. Ресурс игнорируется в случае использования этой функции!

17. Организация и структура базы данных компонентов системы

Узлы и подсистемы системы OpenSCADA могут иметь собственные таблицы в БД для хранения своих данных. При этом структура таблиц индивидуальна и определяется объектом "TConfig". Узлы и подсистемы должны создавать и конфигурировать объект "TConfig" под свои требования.

17.1. Системные таблицы

Система OpenSCADA имеет две системные таблицы BD и SYS. Таблица BD содержит записи зарегистрированных БД, а таблица SYS содержит данные общесистемных параметров.

Таблица 7. Cтруктура таблицы общесистемных параметров (SYS).

Пользователь <user>	Идентификатор параметра <id>	Значение параметра <val>
root	/DemoStation/MessLev	0
user	/DemoStation/Workdir	/mnt/home/roman/work/OScadaD/share/OpenScada
user	/DemoStation/UI/QTStarter/StartMod	QTCfg

Таблица 8. Cтруктура таблицы зарегистрированных БД.

Идентификатор <ID>	Тип БД <TYPE>	Имя <NAME>	Описание <DESCR>	Адрес <ADDR>	Кодировка содержимого БД <CODEPAGE>	Включать <EN>
LibBD	MySQL	Библиотека функций		server.diya.org;roman;123456;oscadaUserLibs	KOI8-U	1
AnastModel	SQLite	Модель АГЛКС		./DATA/AGLKSModel.db	UTF8	1
GenDB	MySQL	Основная БД		server.diya.org;roman;123456;oscadaDemoSt	KOI8-U	1

17.2. Таблицы подсистемы "Сбор данных"

Контроллеры (источники данных) подсистемы "Сбор данных" хранятся в таблицах своих подсистем с именем DQA_{ModName}. Структуры этих таблиц могут значительно отличаться, однако у всех них присутствуют обязательные поля. Общая структура таблиц контроллеров представлена в таблице 9.

Таблица 9. Общая структура таблиц контроллеров подсистемы "Сбор данных" (DQA_{ModName}).

Идентификатор <ID>	Имя контроллера <NAME>	Описание <DESCR>	Включать<ENABLE>	Запускать <START>	Индивидуальные параметры
AutoDA	Автоматический источник	Сбор данных из активных источников с автоматическим их выявлением.	1	1	...

Также как и таблица контроллеров, таблицы параметров для различных типов источников данных могут значительно отличаться, но также имеют обязательные поля. Кроме отличия, характерного для типа источника данных, таблицы параметров ещё могут быть разными для различных типов параметров. Общая структура таблицы параметров приведена в таблице 10.

Таблица 10. Общая структура таблиц параметров подсистемы "Сбор данных".

Шифр параметра <SHIFR>	Имя параметра <NAME>	Описание параметра <DESCR>	Включать <EN>	Индивидуальные параметры
P3	P3	Давление на диафрагме	1	...

Кроме контроллеров и параметров подсистема "Сбор данных" содержит шаблоны параметров. Шаблоны параметров сгруппированы по библиотекам шаблонов и хранятся в таблицах трёх типов: таблица библиотек шаблонов (ParamTemplLibs) таблица 11, таблица шаблонов параметров таблица 12 и таблица параметр шаблонов таблица 13.

Таблица 11. Структура таблицы библиотек шаблонов.

Идентификатор <ID>	Имя <NAME>	Описание <DESCR>	Таблица БД библиотеки <DB>
base	Базовые шаблоны	Библиотека базовых шаблонов	tmplib_base
S7		Библиотека шаблонов для контроллеров серии Siemens S7.	tmplib_S7

Таблица 12. Структура таблицы шаблонов.

Идентификатор <ID>	Имя <NAME>	Описание <DESCR>	Текст процедуры шаблона <PROGRAM>
digAlarm	Дискр. сигнал	Сигнализация по дискретному параметру	JavaLikeCalc.JavaScript
simpleBoard	Простые границы	Формирование простых границ для аналогового сигнала.	JavaLikeCalc.JavaScript

Таблица 13. Структура таблицы параметров шаблонов.

Идентификатор шаблона <TMPL_ID>	Идентификатор параметра <ID>	Имя <NAME>	Тип <TYPE>	Флаги <FLAGS>	Значение <VALUE>	Позиция <POS>
digAlarm	in	Вход	3	144		2
digitBlock	cmdOpen	Команда открытия	3	161	Параметр:com	0

17.3. Таблицы подсистемы “Транспорты”

Подсистема “Транспорты” делится на входящие и исходящие транспорты. Для каждого типа транспортов существует своя таблица с собственной структурой. Имена таблиц соответственно: Transport_In и Transport_Out. Таблицы могут дополняться полями, характерными для типа транспорта.

Таблица 14. Структура таблицы входящих транспортов (Transport_in).

Идентификатор <ID>	Тип <MODULE>	Имя <NAME>	Описание <DESCRIPT>	Адрес <ADDR>	Протокол <PROT>	Запускать <START>	Индивидуальные поля типов транспортов
web1	Sockets	Web 1	Work web transport for proced http requests.	TCP::10002:0	HTTP	1	...
Self	SelfSystem	TCP 1	Test TCP input socket!	Sockets	TCP::10001:1	1	...

Таблица 15. Структура таблицы исходящих транспортов (Transport_out).

Идентификатор <ID>	Тип <MODULE>	Имя <NAME>	Описание <DESCRIPT>	Адрес <ADDR>	Запускать <START>	Индивидуальные поля типов транспортов
tcp_o1	Sockets	TCP Out 1	Output TCP transport 1	TCP::10001	1	...

Для централизованного описания перечня внешних OpenSCADA станций используется таблица внешних хостов (CfgExtHosts). Структура этой таблицы приведена в таблице 16.

Таблица 16. Структура таблицы внешних OpenSCADA хостов (CfgExtHosts).

Пользователь системы <OP_USER>	Идентификатор <ID>	Имя <NAME>	Транспорт <TRANSP>	Адрес удалённого хоста <ADDR>	Пользователь внешнего хоста <USER>	Пароль пользователя внешнего хоста <PASS>
tcp_o1	Sockets	TCP Out 1	Output TCP transport 1	TCP::10001	1	...

17.4. Таблицы подсистемы “Архивы”

Подсистема “Архивы” содержит три таблицы с фиксированными именами:

Архивы значений: Archive_val;
Архиваторы значений: Archive_val_proc;
Архиваторы сообщений: Archive_mess_proc.

Таблицы архиваторов могут дополняться полями, характерными для каждого типа архиватора.

Таблица 17. Структура таблицы архивов значений (Archive_val).

Идентификатор <ID>	Имя <NAME>	Описание <DESCR>	Запускать <START>	Режим источника значений <SrcMode>	Источник значений <Source>	Тип значений <VTYPE>	Периодичность буфера <BPER>	Размер буфера <BSIZE>	Жесткая сетка буфера <BHGRD>	Высокое разрешение времени буфера <BHRES>	Перечень обслуживающих архиваторов <ArchS>
CPULoad_load			1	1	DAQ.System.AutoDA.CPULoad.load	4	1	100	0	0	FSArch.1s;DBArch.1m;FSArch.1m;
ai1_dP			0	0		4	0.0001	100	1	1	FSArch.POMP_20070301;FSArch.1s;

Таблица 18. Структура таблицы архиваторов значений (Archive_val_proc).

Идентификатор <ID>	Тип архиватора <MODUL>	Имя <NAME>	Описание <DESCR>	Запускать <START>	Адрес <ADDR>	Период значений <V_PER>	Период архивирования <A_PER>	Индивидуальные поля типов архиваторов
1s	FSArch		Односекундный	1	ARCHIVES/VAL/1s	1	60	...
POMP_20070301	FSArch			0	ARCHIVES/VAL/POMP_20070301	0.0001	60	...

Таблица 19. Структура таблицы архиваторов сообщений (Archive_mess_proc).

Идентификатор <ID>	Тип архиватора <MODUL>	Имя <NAME>	Описание <DESCR>	Запускать <START>	Шаблон категории сообщений <CATEG>	Уровень сообщений <LEVEL>	Адрес <ADDR>	Индивидуальные поля типов архиваторов
StatErrors	FSArh	Ошибки станции		1	/DemoStation*	4	ARCHIVES/MESS/stError/	...
NetRequsts	FSArh	Сетевые запросы		1	/DemoStation/Transport/Sockets*	1	ARCHIVES/MESS/Net/	...

17.5. Таблицы подсистемы “Безопасность”

Подсистема “Безопасность” содержит две таблицы: таблица пользователей системы (Security_user) и групп системы (Security_grp).

Таблица 20. Структура таблицы пользователей системы (Security_user).

Имя <NAME>	Описание <DESCR>	Пароль <PASS>	Изображение <PICTURE>
root	Суперпользователь	openscada
user	Пользователь	user

Таблица 21. Структура таблицы групп пользователей системы (Security_grp).

Имя <NAME>	Описание <DESCR>	Пользователи в группе <USERS>
root	Группа суперпользователей	root;user
users	Группа пользователей	toot;user

17.6. Структура баз данных модулей

Каждый модуль может иметь собственные таблицы БД для хранения индивидуальных данных. Структура таблиц БД модулей может формироваться свободно, исходя из внутренних потребностей.

18. Сервисные функции интерфейса управления OpenSCADA

Сервисные функции — это интерфейс доступа к системе OpenSCADA посредством интерфейса управления OpenSCADA из внешних систем. Данный механизм положен в основу всех механизмов обмена внутри OpenSCADA, реализованных посредством слабых связей и стандартного протокола обмена OpenSCADA. Основным его преимуществом является приоритетная обработка и возможность использования нестандартной упаковки данных. Для доступа к обычным данным можно использовать стандартные команды интерфейса управления.

18.1. Групповой доступ к значениям атрибутов параметров подсистемы "Сбор данных", а также к детальной информации

Данные запросы позволяют получить детальную информацию о параметрах подсистемы "Сбор данных", запросить значения всех атрибутов параметров, а также выполнить групповую установку. Детальная информация о запросах приведена в таблице 23.

Таблица 23. Атрибуты команд запроса атрибутов параметров подсистемы "Сбор данных"

Id	Имя	Значение
Команда запроса информации об атрибутах параметра: <list path="/sub_DAQ/mod_{SRC}/cntr_{CNTR}/prm_{PRM}/%2fserv%2fattr"/>
<el id="iatr"/>	Информация атрибутов	В отдельных тегах возвращается информация об атрибуте.
id	Идентификатор атрибута	Символьный идентификатор отдельно взятого атрибута.
nm	Имя атрибута	Имя отдельно взятого атрибута.
flg	Флаги атрибута	Флаги отдельно взятого атрибута.
tp	Тип атрибута	Тип отдельно взятого атрибута.
vals	Область значений атрибута.	Область значений отдельно взятого атрибута.
names	Имена значений атрибута для выборочного типа.	Имена значений отдельно взятого атрибута для выборочного типа.
Команда запроса значений всех атрибутов параметра: <get path="/sub_DAQ/mod_{SRC}/cntr_{CNTR}/prm_{PRM}/%2fserv%2fattr"/>
<el id="iatr">val</el>	Значения атрибутов	В отдельных тегах возвращается значение атрибутов.
Команда установки значений указанных атрибутов параметра: <set path="/sub_DAQ/mod_{SRC}/cntr_{CNTR}/prm_{PRM}/%2fserv%2fattr"/>
<el id="iatr">val</el>	Указываются значения атрибутов	В отдельных тегах указываются значение атрибутов.

18.2. Доступ к архивным данным архивов сообщений

Для запроса и установки данных архива в подсистеме архивирования объекта архива сообщений предусмотрена команда <info path="/sub_Archive/%2fserv%2fmess"/>, <get path="/sub_Archive/%2fserv%2fmess"/> и <set path="/sub_Archive/%2fserv%2fmess"/> для запроса информации об архиве, значений архива и установки значений в архив, соответственно. В объекте контроллера подсистемы "Сбор данных" предусмотрен похожий сервисный запрос сообщений генерированных источником данных <get path="/sub_DAQ/{DAQ_TP}/{DAQ_CNTR}/%2fserv%2fmess"/>. Детальное описание данных команд представлено в таблице 24.

Таблица 24. Атрибуты команд запроса информации об архиве значений и архивных данных

Id	Имя	Значение
Команда запроса информации об архиве: <info path="/sub_Archive/%2fserv%2fmess"/>
arch	Установка имени архиватора архива	Архиватор архива, для которого определять параметры.
end	Контроль вершины архива в данном архиваторе	В результате запроса указывает на реальную вершину архива сообщений в данном архиваторе <arch>.
beg	Контроль глубины архива в данном архиваторе	В результате запроса указывает на реальную глубину архива сообщений в данном архиваторе <arch>.
Команда запроса архивных и/или текущих данных: <get path="/sub_Archive/%2fserv%2fmess"/>
tm	Установка времени	Время вершины блока архива сообщений.
tm_grnd	Установка времени основания/начала архива	Указывает основание/начало архива.
arch	Установка архиватора архива	Указывает, у какого архиватора запрашивать значения. Если архиватор не указан, то запрос будет производиться последовательно у всех архиваторов с исключением дубликатов.
cat	Установка категории сообщений	Указывает категорю/шаблоны запрашиваемых сообщений.
lev	Установка уровня важности	Указывает уровень важности сообщений, для которого и выше получать сообщения.
<el>{mess}</el>	Сообщения	В отдельных тегах возвращаются сообщения.
time, utime	Время сообщения (секунды, микросекунды)	Время отдельно взятого сообщения.
cat	Категория сообщения	Категория отдельно взятого сообщения.
lev	Уровень сообщения	Уровень отдельно взятого сообщения.
Команда установки архивных данных: <set path="/sub_Archive/%2fserv%2fmess"/>
<el>{mess}</el>	Сообщения	В отдельных тегах указываются сообщения для установки.
time, utime	Время сообщения (секунды, микросекунды)	Время отдельно взятого сообщения.
cat	Категория сообщения	Категория отдельно взятого сообщения.
lev	Уровень сообщения	Уровень отдельно взятого сообщения.
Команда запроса архивных и/или текущих данных источника данных: <get path="/sub_DAQ/{DAQ_TP}/{DAQ_CNTR}/%2fserv%2fmess"/>
tm	Установка времени	Время вершины блока архива сообщений. Если значение нулевое то запрос осуществляется от текущего времени и это время возвращается.
tm_grnd	Установка времени основания/начала архива	Указывает основание/начало архива.
lev	Установка уровня важности	Указывает уровень важности сообщений, для которого и выше получать сообщения.
<el>{mess}</el>	Сообщения	В отдельных тегах возвращаются сообщения.
time, utime	Время сообщения (секунды, микросекунды)	Время отдельно взятого сообщения.
cat	Категория сообщения	Категория отдельно взятого сообщения.
lev	Уровень сообщения	Уровень отдельно взятого сообщения.

18.3. Доступ к архивным данным архивов значений

Для запроса данных архива в подсистеме архивирования объекта архива значения и объекте атрибута параметра подсистемы сбора данных предусмотрена команда <info path="{a_p_addr}/%2fserv%2fval"/> и <get path="{a_p_addr}/%2fserv%2fval"/> для запроса информации об архиве и значений архива соответственно. Атрибуты данных команд, предусматривающие различные механизмы запроса, представлены в таблице 25.

Таблица 25. Атрибуты команд запроса информации об архиве значений и архивных данных

Id	Имя	Значение
Команда запроса информации об архиве: <info path="{a_p_addr}/%2fserv%2fval"/>
arch	Установка имени архиватора архива	Архиватор архива, для которого определять параметры.
end	Контроль вершины архива в данном архиваторе	В результате запроса указывает на реальную вершину архива значений в данном архиваторе <arch>. В случае отсутствия архива атрибут устанавливается в "0".
beg	Контроль глубины архива в данном архиваторе	В результате запроса указывает на реальную глубину архива значений в данном архиваторе <arch>. В случае отсутствия архива атрибут устанавливается в "0".
per	Контроль периодичности архива в данном архиваторе	В результате запроса указывает на реальную периодичность значений в данном архиваторе <arch>. В случае отсутствия архива атрибут устанавливается в "0".
vtp	Контроль типа значений архива/параметра	Возвращает код типа значений архивных данных: 0 — Boolean, 1 — Integer, 4 — Real, 5 — String. Только данное свойство доступно в случае запроса у параметра без архива!
Команда запроса архивных и/или текущих данных: <get path="{a_p_addr}/%2fserv%2fval"/>
tm	Установка и контроль времени	Время запрашиваемого значения или вершины блока архива значений. Если атрибут не указан или равен "0", то возвращается последнее значение. Значение данного атрибута устанавливается в значение времени полученного значения или вершины блока архивных данных.
tm_grnd	Установка и контроль времени основания/начала архива	Указывает основание/начало архива. Если атрибут не указан или равен "0", то производится запрос одного значения. Значение данного атрибута устанавливается в значение времени основания блока архивных данных.
per	Установка и контроль периодичности получаемых значений	Периодичность запрашиваемых значений. Если атрибут не указан, равен "0" или меньше чем реальная периодичность архива, то значения будут возвращаться с реальной периодичностью архива и значение данного атрибута установится в значение реальной периодичности. Если значение атрибута больше реальной периодичности, то значения архива будут усредняться к указанной периодичности.
arch	Установка и контроль архиватора архива	Указывает, у какого архиватора запрашивать значения. Если архиватор не указан, то запрос будет производиться последовательно с приоритетностью от лучшего к худшему. Имя архиватора, у которого получены значения, будет указанно в данном атрибуте при возврате результата. Если архиватор для данного параметра не установлен или такого архиватора нет, то значение данного атрибута будет обнулено. В случае выполнение запроса, пересекающего несколько архиваторов, выполняется обработка только первого архиватора с указанием его имени и размерности в соответствующих атрибутах. Для запроса данных последующих архиваторов запрос повторяется отталкиваясь от размерности предыдущего запроса.
mode	Установка и контроль режима передачи данных архива	Указывается форма, в которой желательно получать данные архива. Предусматриваются следующие режимы/формы передачи данных архивов: 0 — Простая запись: одно значение — одна строка без упаковки смежных значений. В случае архива строк значения кодируются на предмет исключения символов перевода строки. Пример формы записи: `34.5678 23.6543 65.8754 34.6523` 1 — Упакованная запись по принципу сворачивания смежных значений: одно значение — одна запись. Перед каждым значением указывается его позиционный номер, отделённый пробелом: `0 34.5678 1 23.6543 4 65.8754 6 34.6523` 2 — Массив бинарных неупакованных значений, кодированный Mime Base64. Не может быть использован для строковых архивов.
real_prec	Установка точности вещественных чисел	Указывает, с какой точностью передавать данные значений вещественного типа в режиме "0" и "1". По умолчанию эта точность составляет 6 значащих цифр.
round_perc	Установка процента округления	Указывает процент округления смежных числовых значений, для режима "1".
Команда запроса имени архивного параметра или самого архива: <name path="{a_p_addr}/%2fserv%2fval"/>

19. API модулей модульных подсистем

Модули в системе OpenSCADA реализуются в виде разделяемых библиотек. Как уже ранее упоминалось, одна такая библиотека может содержать множество модулей подсистем OpenSCADA, фактически выступая в роли контейнера.

Первым шагом при подключении разделяемых (SO — shared object) библиотек является подключение функций инициализации. Эти функции должны быть определены как обычные “С” функции для исключения искажения имен функций. Обычно это делается следующим образом:


//================== CUT =========================
extern "C"
{
#ifdef MOD_INCL
    //Нужно указывать только в случае поддержки модулем возможности
    //влинковки в ядро OpenSCADA
    TModule::SAt bd_DBF_module( int n_mod )
#else
    TModule::SAt module( int n_mod )
#endif
    {
    //Формирование описателей модулей из списка
    //доступных в разделяемой библиотеке.
    }

#ifdef MOD_INCL
    //Нужно указывать только в случае поддержки модулем возможности
    //влинковки в ядро OpenSCADA
    TModule *bd_Tmpl_attach( const TModule::SAt &AtMod, const string &source )
#else
    TModule *attach( const TModule::SAt &AtMod, const string &source )
#endif
    {
    //Подключить указанный модуль
    }
}
//================== CUT =========================

Функции для работы с разделяемой библиотекой:
TModule::SAt module( int n_mod );

Функция предназначена для последовательного опроса информации о модулях, содержащихся в SO библиотеке. Параметр n_mod указывает на порядковый номер запрашиваемого модуля и должен перебираться, начиная с нуля. В случае отсутствия модуля с данным идентификатором функция должна возвращать структуру с именем модуля нулевой длины, что и служит окончанием процесса сканирования.

TModule *attach( const TModule::SAt &AtMod, const string &source );

Подключение к указанному модулю.

Практически все функции и данные системы сведены в API-системы, описываемого в данном документе. Однако для упрощения и ускорения процесса написания модулей основные функции, переопределяемые в модулях, приведены в таблице 22.

Таблица 22. Основные функции, использующиеся при создании модулей

Общее API

API объекта (TCntrNode):

virtual void load_( ); — Загрузка объекта из хранилища.
virtual void save_( ); — Сохранение объекта в хранилище.

Общее API модулей (TModule):

Атрибуты:

string mId; — Идентификатор модуля.
string mName; — Имя модуля.
string mDescr; — Описание модуля.
string mType; — Тип модуля.
string mVers; — Версия модуля.
string mAutor; — Автор модуля.
string mLicense; — Лицензия модуля.
string mSource; — Источник/происхождение модуля.

Методы:

virtual void modStart( ); — Запуск модуля.
virtual void modStop( ); — Останов модуля.
virtual void modInfo( vector<string> &list ); — Список доступных элементов информации о модуле. Предусмотрены следующие информационные элементы:
Module — идентификатор модуля;
Name — локализованное имя модуля;
Type — тип модуля;
Source — источник модуля (контейнер);
Version — версия модуля;
Author — автора модуля;
Description — описание модуля;
License — лицензия модуля.
virtual string modInfo( const string &name ); — Запрос указанного элемента информации.
virtual void perSYSCall( unsigned int cnt ); — Вызов из системного потока, с периодичностью 10 секунд и секундным счётчиком cnt.
void postEnable( int flag ); — Подключение модуля к динамическому дереву объектов.
void modFuncReg( ExpFunc *func ); — Регистрация экспортируемой функции.

API модулей подсистемы “БД”.

Тип БД (потомок от TTypeBD):

virtual TBD *openBD( const string &id ); — Открыть/создать БД.

БД (потомок от TBD):

virtual void enable( ); — Включение БД.
virtual void disable( ); — Отключение БД.
virtual void allowList( vector<string> &list ) const; — Перечень таблиц в БД.
virtual void sqlReq( const string &req, vector< vector<string> > *tbl = NULL, char intoTrans = EVAL_BOOL ); — Отправка SQL-запроса req на БД и получение результата в виде таблицы tbl. При установке intoTrans в true для запроса будет открыта транзакция, в false будет закрыта.
virtual void transCloseCheck( ) — Периодически вызываемая функция для проверки транзакций и закрытия старых или содержащих много запросов.
virtual TTable *openTable( const string &table, bool create ); — Открыть/создать таблицу.

Таблица (потомок от TTable):

virtual void fieldStruct( TConfig &cfg ); — Получение структуры таблицы.
virtual bool fieldSeek( int row, TConfig &cfg ); — Последовательное сканирование записей таблицы.
virtual void fieldGet( TConfig &cfg ); — Получение указанной записи.
virtual void fieldSet( TConfig &cfg ); — Установка указанной записи.
virtual void fieldDel( TConfig &cfg ); — Удаление указанной записи.

API модулей подсистемы "Транспорты".

Тип транспорта (потомок от TTypeTransport):

virtual TTransportIn *In( const string &name, const string &db ); — Создать/открыть новый "Входящий" транспорт.
virtual TTransportOut *Out( const string &name, const string &db ); — Создать/открыть новый "Исходящий" транспорт.

Входящий транспорт (потомок от TTransportIn):

virtual string getStatus( ); — Статус интерфейса.
virtual void setAddr( const string &addr ); — Установка адреса транспорта. Может переопределяться для обработки и проверки специфического для модуля формата адреса транспорта.
virtual void start(); — Запуск транспорта.
virtual void stop(); — Останов транспорта.

Исходящий транспорт (потомок от TTransportOut):

virtual string getStatus( ); — Статус интерфейса.
virtual void setAddr( const string &addr ); — Установка адреса транспорта. Может переопределяться для обработки и проверки специфического для модуля формата адреса транспорта.
virtual void start( ); — Запуск транспорта.
virtual void stop( ); — Останов транспорта.
virtual int messIO( const char *obuf, int len_ob, char *ibuf = NULL, int len_ib = 0, int time = 0 ); — Отправка данных через транспорт. Время ожидания time соединения указывается в миллисекундах.

API модулей подсистемы "Протоколы".

Протокол (потомок от TProtocol):

virtual void itemListIn( vector<string> &ls, const string &curIt = "" ); — Перечень подєлементов у входящего протокола, если протокол их предусматривает. Используется при выборе в конфигурации объекта входящего транспорта.
virtual void outMess( XMLNode &io, TTransportOut &tro ); — Передача данных в дереве XML in удалённой системе посредством транспорта tro и текущего исходящего протокола.
virtual TProtocolIn *in_open( const string &name ) — Открыть/создать входной протокол.

Входной протокол (потомок от TProtocolIn):

virtual bool mess( const string &request, string &answer, const string &sender ); — Передача неструктурированного сообщения в протокол.

API модулей подсистемы “Сбор данных”.

Тип контроллера (потомок от TTypeDAQ):

virtual void compileFuncLangs( vector<string> &ls ); — Перечень языков пользовательского программирования, поддерживаемых модулем.
virtual void compileFuncSynthHighl( const string &lang, XMLNode &shgl ); — Запрос правил подсветки синтаксиса shgl указанного языка пользовательского программирования lang.
virtual string compileFunc( const string &lang, TFunction &fnc_cfg, const string &prog_text ); — Компиляция пользовательской процедуры и создания объекта исполнения функции для указанного языка пользовательского программирования.
virtual bool redntAllow( ); — Признак поддержки механизмов резервирования модулем. Должен просто переопределяться и возвращать true.
virtual TController *ContrAttach( const string &name, const string &daq_db ); — Открытие/подключение контроллера.

Контроллер (потомок от TController):

virtual string getStatus( ); — Вызов для получения специфического статуса контроллера.
virtual void enable_( ); — Включение контроллера.
virtual void disable_( ); — Отключение контроллера.
virtual void start_( ); — Запуск контроллера.
virtual void stop_( ); — Останов контроллера.
virtual void redntDataUpdate( bool firstArchiveSync = false ); — Выполнение операции получения данных из резервной станции. Вызывается автоматически задачей обслуживания схемы резервирования и перед запуском для синхронизации архивов с установленным параметром firstArchiveSync.
virtual TParamContr *ParamAttach( const string &name, int type ); — Создание/открытие нового параметра.

Параметр контроллера (потомок от TParamContr->TValue):

virtual void enable( ); — Включить параметр.
virtual void disable( ); — Отключить параметр.
virtual void setType( const string &tpId ); — Вызывается для смены типа параметра tpId и может быть обработан в объекте модуля, для смены собственных данных.
virtual TVal* vlNew( ); — Вызывается при создании нового атрибута. Может быть переопределён для реализации особого поведения в рамках своего, наследованного от TVal, класса при доступе к атрибуту.
virtual void vlSet( TVal &val, const TVariant &pvl ); — Вызывается для атрибута с прямым режимом записи TVal::DirWrite (синхронный режим или запись во внутренний буфер объекта) при установке значения, с целью непосредственной записи значения в физический контроллер или буфер объекта.
virtual void vlGet( TVal &val ); — Вызывается для атрибута с прямым режимом чтения TVal::DirRead (синхронный режим или чтение из внутреннего буфера объекта) при чтении значения, с целью непосредственного чтения значения из физического контроллера или буфера объекта.
virtual void vlArchMake( TVal &val ); — Вызывается при создании архива значений с атрибутом val в качестве источника с целью инициализации качественных характеристик буфера архива согласно особенностям источника данных и их опроса.

API модулей подсистемы "Архивы".

Тип архиватора (потомок от TTypeArchivator):

virtual TMArchivator *AMess(const string &id, const string &db ); — Создание архиватора сообщений.
virtual TVArchivator *AVal(const string &id, const string &db ); — Создание архиватора значений.

Архиватор сообщений (потомок от TMArchivator):

virtual void start( ); — Старт архиватора.
virtual void stop( ); — Останов архиватора.
virtual time_t begin( ); — Начало данных в архиваторе.
virtual time_t end( ); — Конец данных в архиваторе.
virtual void put( vector<TMess::SRec> &mess ); — Передать сообщение архиватору.
virtual void get( time_t b_tm, time_t e_tm, vector<TMess::SRec> &mess, const string &category = "", char level = 0, time_t upTo = 0 ); — Запросить сообщение из архиватора.

Архиватор значений (потомок от TVArchivator):

virtual void setValPeriod( double per ); — Установить периодичность значений архиватора.
virtual void setArchPeriod( int per ); — Установить периодичность архивирования.
virtual void start( ); — Запустить архиватор.
virtual void stop( bool full_del = false ); — Остановить архиватор с возможностью полного удаления, если установлен full_del.
virtual TVArchEl *getArchEl( TVArchive &arch ); — Получение архива arch, обслуживаемого архиватором.

Архивный элемент значений (потомок от TVArchEl):

virtual void fullErase( ); — Полное удаление части архива в архиваторе.
virtual int64_t end( ); — Время окончания архива в архиваторе.
virtual int64_t begin( ); — Время начала архива в архиваторе.
virtual TVariant getValProc( long long *tm, bool up_ord ); — Функция обработки запроса одного значения из архива.
virtual void getValsProc( TValBuf &buf, int64_t beg, int64_t end ); — Функция обработки запроса модулем на получение данных группы значений buf за указанный промежуток времени.
virtual void setValsProc( TValBuf &buf, int64_t beg, int64_t end ); — Функция обработки запроса модулем на установку данных группы значений buf за указанный промежуток времени.

API модулей подсистемы "Пользовательские интерфейсы".

Пользовательский интерфейс (потомок от TUI):
Не содержит специфических функций!

API модулей подсистемы "Специальные”.

Специальные (потомок от TSpecial):
Не содержит специфических функций!

20. Отладка и тестирование проекта OpenSCADA

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

21. Правила оформления и комментирования исходных текстов OpenSCADA и его модулей

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

отступ между уровнями вложений: 4 символа;
размер табуляции: 8 символов;
фигурные скобки открытия располагается на уровне предыдущей команды, если она короче 80 символов
фигурные скобки закрытия располагается в отдельных строках;
возможно написание вложений в одной строке с предыдущим уровнем вложения, в случае повышения читабельности кода;
расстояние между описаниями функций не менее одного символа;
расстояние между определением переменных и текстом программы не менее одного символа;
допускается определение переменных в тексте при сохранении читабельности;
избегать длины строки более 100 символов;
команды препроцессора располагать на первом уровне вне зависимости от текущего уровня текста;
для форматирования исходного текста, наследованного у других свободных приложений и примеров, рекомендуется использовать утилиту:

indent -bli0 -i4 -ts8 -l100 -npsl -npcs -nprs -nsaf -nsai -nsaw -brs -br -cdw -nbc -lp <filename>.

Правила комментирования исходных текстов OpenSCADA:

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

22. Условные обозначения по тексту и в исходниках

???? — сомнение в целесообразности данного участка;
?!?! — участок не полностью реализован;
!!!! — участок требует переосмысления.

Ссылки

Referring pages: Doc
Doc/ModuleBuild
Doc/OPCUA
Doc/OpenSCADA060
Doc/SelfSystem
Doc/VCA/part4/part5
Doc/VCA/part6/part1
HomePageEn/Doc/SelfSystem
HomePageUk/Doc
HomePageUk/Doc/ModuleBuild
HomePageUk/Doc/OPCUA
HomePageUk/Doc/OpenSCADA060
HomePageUk/Doc/SelfSystem