From OpenSCADAWiki
Line 5: | Line 5: | ||
* ''string descr( )'' — опис об'єкту та контролеру. | * ''string descr( )'' — опис об'єкту та контролеру. | ||
* ''string status( )'' — статус контролеру. | * ''string status( )'' — статус контролеру. | ||
− | * ''bool messSet( string mess, int lev, string type2Code = "OP", string prm = "", string cat = "")'' — встановлює повідомлення джерела даних ''mess'' із рівнем ''lev'', для параметру ''prm'' ('''{PrmId}'''), додатковою інформацією категорії ''cat'' та кодом типу ''type2Code''. Ця функція [[Special:MyLanguage/Documents/Program_manual#ArchMess|формує повідомлення]] з уніфікованою категорією транспортування через джерело даних '''{type2Code}{ModId}:{CntrId}[.{PrmId}][:{cat}]''', де: | + | * ''bool messSet( string mess, int lev, string type2Code = "OP", string prm = "", string cat = "")'' — встановлює повідомлення джерела даних ''mess'' із рівнем ''lev'', для параметру ''prm'' ('''{PrmId}\n{PrmNm}'''), додатковою інформацією категорії ''cat'' та кодом типу ''type2Code''. Ця функція [[Special:MyLanguage/Documents/Program_manual#ArchMess|формує повідомлення]] з уніфікованою категорією транспортування через джерело даних '''{type2Code}{ModId}:{CntrId}[.{PrmId}][:{cat}]''' та текстом '''{CntrNm} > {PrmNm}: {MessText}''', де: |
** ''type2Code'' — двосимвольний код типу повідомлення, по замовченню означає дію оператору "OP"; | ** ''type2Code'' — двосимвольний код типу повідомлення, по замовченню означає дію оператору "OP"; | ||
** ''ModId'' — ідентифікатор модуля; | ** ''ModId'' — ідентифікатор модуля; | ||
** ''CntrId'' — ідентифікатор об'єкту контролера; | ** ''CntrId'' — ідентифікатор об'єкту контролера; | ||
** ''PrmId'' — ідентифікатор параметру, з аргументу ''prm''; | ** ''PrmId'' — ідентифікатор параметру, з аргументу ''prm''; | ||
− | ** ''cat'' — додаткова інформація категорії яку визначено для типу ''type2Code''. | + | ** ''cat'' — додаткова інформація категорії яку визначено для типу ''type2Code'' |
+ | ** ''CntrNm'' — назва об'єкту контролера, тобто встановлення або із поля опису "'''MessName: {Name}'''" (навіть порожнє для приховування) або із непорожньої назви; | ||
+ | ** ''PrmNm'' — назва параметру, з аргументу ''prm''; | ||
+ | ** ''MessText'' — текст повідомлення. | ||
* ''bool alarmSet( string mess, int lev = -5, string prm = "", bool force = false )'' — встановлює/знімає порушення ''mess'' із рівнем ''lev'' (негативне для встановлення інакше зняття), для параметру ''prm'' ('''{PrmId}\n{PrmNm}'''). Очищення порушень, так як і встановлення, працює у режимі перемикача, що передбачає пропуск повідомлень очищення до буферу повідомлень, та саме очищення, лише за наявності відповідного порушення, що може бути вимкнено встановленням ''force''. Функція формує порушення з категорією '''al{ModId}:{CntrId}[.{PrmId}]''' та текстом '''{CntrNm} > {PrmNm}: {MessText}''', де: | * ''bool alarmSet( string mess, int lev = -5, string prm = "", bool force = false )'' — встановлює/знімає порушення ''mess'' із рівнем ''lev'' (негативне для встановлення інакше зняття), для параметру ''prm'' ('''{PrmId}\n{PrmNm}'''). Очищення порушень, так як і встановлення, працює у режимі перемикача, що передбачає пропуск повідомлень очищення до буферу повідомлень, та саме очищення, лише за наявності відповідного порушення, що може бути вимкнено встановленням ''force''. Функція формує порушення з категорією '''al{ModId}:{CntrId}[.{PrmId}]''' та текстом '''{CntrNm} > {PrmNm}: {MessText}''', де: | ||
** ''ModId'' — ідентифікатор модуля; | ** ''ModId'' — ідентифікатор модуля; | ||
** ''CntrId'' — ідентифікатор об'єкту контролера; | ** ''CntrId'' — ідентифікатор об'єкту контролера; | ||
** ''PrmId'' — ідентифікатор параметру, з аргументу ''prm''; | ** ''PrmId'' — ідентифікатор параметру, з аргументу ''prm''; | ||
− | ** ''CntrNm'' — назва об'єкту контролера; | + | ** ''CntrNm'' — назва об'єкту контролера, тобто встановлення або із поля опису "'''MessName: {Name}'''" (навіть порожнє для приховування) або із непорожньої назви; |
** ''PrmNm'' — назва параметру, з аргументу ''prm''; | ** ''PrmNm'' — назва параметру, з аргументу ''prm''; | ||
** ''MessText'' — текст повідомлення. | ** ''MessText'' — текст повідомлення. | ||
* ''bool enable( bool newSt = '''EVAL''' )'' — отримує стан "Включений" або змінює його призначенням атрибуту ''newSt''. | * ''bool enable( bool newSt = '''EVAL''' )'' — отримує стан "Включений" або змінює його призначенням атрибуту ''newSt''. | ||
* ''bool start( bool newSt = '''EVAL''' )'' — отримує стан "Виконується" або змінює його призначенням атрибуту ''newSt''. | * ''bool start( bool newSt = '''EVAL''' )'' — отримує стан "Виконується" або змінює його призначенням атрибуту ''newSt''. |
Latest revision as of 09:29, 25 May 2025
Функції об'єкту контролеру (SYS.DAQ["Modul"]["Controller"]):
- ElTp cfg( string nm ) — отримує значення конфігураційного поля nm об'єкту.
- bool cfgSet( string nm, ElTp val ) [доступ до відповідної підсистеми] — встановлює конфігураційне поля nm об'єкту у значення val.
- string name( ) — ім'я об'єкту контролера.
- string descr( ) — опис об'єкту та контролеру.
- string status( ) — статус контролеру.
- bool messSet( string mess, int lev, string type2Code = "OP", string prm = "", string cat = "") — встановлює повідомлення джерела даних mess із рівнем lev, для параметру prm ({PrmId}\n{PrmNm}), додатковою інформацією категорії cat та кодом типу type2Code. Ця функція формує повідомлення з уніфікованою категорією транспортування через джерело даних {type2Code}{ModId}:{CntrId}[.{PrmId}][:{cat}] та текстом {CntrNm} > {PrmNm}: {MessText}, де:
- type2Code — двосимвольний код типу повідомлення, по замовченню означає дію оператору "OP";
- ModId — ідентифікатор модуля;
- CntrId — ідентифікатор об'єкту контролера;
- PrmId — ідентифікатор параметру, з аргументу prm;
- cat — додаткова інформація категорії яку визначено для типу type2Code
- CntrNm — назва об'єкту контролера, тобто встановлення або із поля опису "MessName: {Name}" (навіть порожнє для приховування) або із непорожньої назви;
- PrmNm — назва параметру, з аргументу prm;
- MessText — текст повідомлення.
- bool alarmSet( string mess, int lev = -5, string prm = "", bool force = false ) — встановлює/знімає порушення mess із рівнем lev (негативне для встановлення інакше зняття), для параметру prm ({PrmId}\n{PrmNm}). Очищення порушень, так як і встановлення, працює у режимі перемикача, що передбачає пропуск повідомлень очищення до буферу повідомлень, та саме очищення, лише за наявності відповідного порушення, що може бути вимкнено встановленням force. Функція формує порушення з категорією al{ModId}:{CntrId}[.{PrmId}] та текстом {CntrNm} > {PrmNm}: {MessText}, де:
- ModId — ідентифікатор модуля;
- CntrId — ідентифікатор об'єкту контролера;
- PrmId — ідентифікатор параметру, з аргументу prm;
- CntrNm — назва об'єкту контролера, тобто встановлення або із поля опису "MessName: {Name}" (навіть порожнє для приховування) або із непорожньої назви;
- PrmNm — назва параметру, з аргументу prm;
- MessText — текст повідомлення.
- bool enable( bool newSt = EVAL ) — отримує стан "Включений" або змінює його призначенням атрибуту newSt.
- bool start( bool newSt = EVAL ) — отримує стан "Виконується" або змінює його призначенням атрибуту newSt.