From OpenSCADAWiki
Jump to: navigation, search

1 API пользовательского программирования и сервисные интерфейсы OpenSCADA

1.1 API пользовательского программирования

API пользовательского программирования движка визуализации непосредственно представлено объектами OpenSCADA, формирующие пользовательский интерфейс, а именно "Сеансом" и "Виджетами-страницами". Для пользователя эти объекты предоставляют набор функций управления:

Объектная модель пользователя модуля VCAEngine.

Объект "Сеанс" ( this.ownerSess() )

  • string user( ) — текущий пользователь сеанса.
  • int alrmQuietance( int quit_tmpl, string wpath = "", bool ret = false ) — квитирует нарушение wpath с шаблоном quit_tmpl. Если wpath это пустая строка то производится глобальное квитирование. В строке wpath, через символ ';', могут быть перечислены адреса нескольких виджетов. При установке ret осуществляется возврат квитирования.
  • int reqTm( ) — время последнего запроса в секундах от эпохи 1.1.1970.
  • string reqUser( ) — пользователь последнего запроса.
  • string reqLang( ) — язык последнего запроса.
  • int userActTm( ) — время последнего действия пользователя в секундах от эпохи 1.1.1970.
  • bool uiCmd( string cmd, string prm, string src ) — отправляет UI команду управления страницами, как: "open", "next", "prev"; детальнее смотрите в секции сообщений. Эта функция должна быть приоритетной для использования при контроле страницами перед прямой записью в атрибут страниц "pgOpen" и "pgOpenSrc" поскольку это единственный метод корректной работы с линкованными страницами.