From OpenSCADAWiki
Jump to: navigation, search

Enter a message name below to show all available translations.

Message

Found 2 translations.

NameCurrent message text
 h English (en)=== {{Anch|UserAPI|API of the user programming}} ===
<section begin=UserAPI />
API of the user programming of the visualization engine are represented directly by the OpenSCADA objects, which form the user interface, that is by the "Session" and "Widgets-pages". For the user, these objects provide a set of control functions:
<section begin=API />
[[File:Oscada UserOM VCAEngine.png|right|User object model of the module VCAEngine.]]
'''Object "Session" ( this.ownerSess() )'''
* ''string user( )'' — current session user.
* ''int alrmQuietance( int quit_tmpl, string wpath = "", bool ret = false )'' — quiets of the violations ''wpath'' with the template ''quit_tmpl''. If ''wpath'' is empty string then the global quietance makes. In the string ''wpath'', by symbol ';', can be enumerated addresses of several widgets. When set the ''ret'', the quietance return is performed.
* ''int reqTm( )'' — last request time in seconds from the epoch of 1/1/1970.
* ''string reqUser( )'' — last request user.
* ''string reqLang( )'' — last request language.
* ''int userActTm( )'' — last user action time in seconds from the epoch of 1/1/1970.
* ''bool uiCmd( string cmd, string prm, string src )'' — sends a UI command of the pages managing, that is: "open", "next", "prev"; for more details see in [[#Events|the events section]]. This function must be in the priority of using to the pages managing before the direct writing to the page attributes "pgOpen" and "pgOpenSrc" due it is single method of the correct work with [[#Project|the linked pages]].
* ''int period( bool isReal = false )'' — getting the session processing period, ''isReal'' for the real one.
 h Ukrainian (uk)=== {{Anch|UserAPI|API користувацького програмування}} ===
<section begin=UserAPI />
API користувацького програмування рушія візуалізації безпосередньо представлено об'єктами OpenSCADA, що формують користувацький інтерфейс, а саме "Сеансом" та "Віджетами-сторінками". Для користувача ці об'єкти надають набір функцій управління:
<section begin=API />
[[File:Oscada UserOM VCAEngine_uk.png|right|Об'єктна модель користувача модуля 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"; детальніше дивиться у [[#Events|секції подій]]. Ця функція має бути пріоритетною для використання у керуванні сторінками перед прямим записом до атрибутів сторінок "pgOpen" та "pgOpenSrc", оскільки це єдиний метод коректної поводження з [[#Project|лінкованими сторінками]].
* ''int period( bool isReal = false )'' — отримання періоду опрацювання сеансу, ''isReal'' для реального періоду.