From OpenSCADAWiki
Jump to: navigation, search
Line 18: Line 18:
 
** ''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''.

Revision as of 18:23, 11 May 2025

Information about message (contribute)
This message has no documentation. If you know where or how this message is used, you can help other translators by adding documentation to this message.
Message definition (Documents/User API)
Functions of the controller object (SYS.DAQ["Modul"]["Controller"]):
* ''ElTp cfg( string nm )'' — gets the value of the configuration field ''nm'' of the object.
* ''bool cfgSet( string nm, ElTp val )'' [<span style='color:red'>access to the appropriate subsystem</span>] — sets the configuration field ''nm'' of the object to the value ''val''.
* ''string name( )'' — name of the controller object.
* ''string descr( )'' — description of the controller object and controller.
* ''string status( )'' — status of the controller.
* ''bool messSet( string mess, int lev, string type2Code = "OP", string prm = "", string cat = "")'' — sets of the DAQ-sourced message ''mess'' with the level ''lev'', for the parameter ''prm'' ('''{PrmId}\n{PrmNm}'''), additional category information ''cat'' and the type code ''type2Code''. This function [[Special:MyLanguage/Documents/Program_manual#ArchMess|forms the messages]] with the unified DAQ-transparency category '''{type2Code}{ModId}:{CntrId}[.{PrmId}][:{cat}]''' and the text '''{CntrNm} > {PrmNm} > {MessText}''', where:
** ''type2Code'' — the message type two-symbol code, by default means the operator actions "OP";
** ''ModId'' — identifier of the module;
** ''CntrId'' — identifier of the controller object;
** ''PrmId'' — parameter identifier, from the argument ''prm'';
** ''CntrNm'' — name of the controller object, that is inserted whether from the description field "'''MessName: {Name}'''" (even empty for hide) or from not empty name;
** ''PrmNm'' — parameter name, from the argument ''prm'';
** ''cat'' — additional category information which specific for the type ''type2Code'';
** ''MessText'' — message text.
* ''bool alarmSet( string mess, int lev = -5, string prm = "", bool force = false )'' — sets/removes of the violation ''mess'' with the level ''lev'' (negative to set otherwise to remove), for the parameter ''prm'' ('''{PrmId}\n{PrmNm}'''). The alarms clearance, as the setting also, works in the toggling mode, so means of passing the clearance messages to the message buffer, and the same clearance, only at the according violations presence, what may be disabled setting ''force''. The function forms the alarms with the category '''al{ModId}:{CntrId}[.{PrmId}]''' and the text '''{CntrNm} > {PrmNm}: {MessText}''', where:
** ''ModId'' — identifier of the module;
** ''CntrId'' — identifier of the controller object;
** ''PrmId'' — parameter identifier, from the argument ''prm'';
** ''CntrNm'' — name of the controller object, that is inserted whether from the description field "'''MessName: {Name}'''" (even empty for hide) or from not empty name;
** ''PrmNm'' — parameter name, from the argument ''prm'';
** ''MessText'' — message text.
* ''bool enable( bool newSt = '''EVAL''' )'' — gets the status "Enabled" or changes it by the argument ''newSt'' assign.
* ''bool start( bool newSt = '''EVAL''' )'' — gets the status "Running" or changes it by the argument ''newSt'' assign.
TranslationФункції об'єкту контролеру (SYS.DAQ["Modul"]["Controller"]):
* ''ElTp cfg( string nm )'' — отримує значення конфігураційного поля ''nm'' об'єкту.
* ''bool cfgSet( string nm, ElTp val )'' [<span style='color:red'>доступ до відповідної підсистеми</span>] — встановлює конфігураційне поля ''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}'''), додатковою інформацією категорії ''cat'' та кодом типу ''type2Code''. Ця функція [[Special:MyLanguage/Documents/Program_manual#ArchMess|формує повідомлення]] з уніфікованою категорією транспортування через джерело даних '''{type2Code}{ModId}:{CntrId}[.{PrmId}][:{cat}]''', де: 
** ''type2Code'' — двосимвольний код типу повідомлення, по замовченню означає дію оператору "OP";
** ''ModId'' — ідентифікатор модуля;
** ''CntrId'' — ідентифікатор об'єкту контролера;
** ''PrmId'' — ідентифікатор параметру, з аргументу ''prm'';
** ''cat'' — додаткова інформація категорії яку визначено для типу ''type2Code''.
* ''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'' — назва об'єкту контролера;
** ''PrmNm'' — назва параметру, з аргументу ''prm'';
** ''MessText'' — текст повідомлення.
* ''bool enable( bool newSt = '''EVAL''' )'' — отримує стан "Включений" або змінює його призначенням атрибуту ''newSt''.
* ''bool start( bool newSt = '''EVAL''' )'' — отримує стан "Виконується" або змінює його призначенням атрибуту ''newSt''.

Функції об'єкту контролеру (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}), додатковою інформацією категорії cat та кодом типу type2Code. Ця функція формує повідомлення з уніфікованою категорією транспортування через джерело даних {type2Code}{ModId}:{CntrId}[.{PrmId}][:{cat}], де:
    • type2Code — двосимвольний код типу повідомлення, по замовченню означає дію оператору "OP";
    • ModId — ідентифікатор модуля;
    • CntrId — ідентифікатор об'єкту контролера;
    • PrmId — ідентифікатор параметру, з аргументу prm;
    • cat — додаткова інформація категорії яку визначено для типу type2Code.
  • 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 — назва об'єкту контролера;
    • PrmNm — назва параметру, з аргументу prm;
    • MessText — текст повідомлення.
  • bool enable( bool newSt = EVAL ) — отримує стан "Включений" або змінює його призначенням атрибуту newSt.
  • bool start( bool newSt = EVAL ) — отримує стан "Виконується" або змінює його призначенням атрибуту newSt.