From OpenSCADAWiki
Jump to: navigation, search
(Importing a new version from external source)
(Importing a new version from external source)
Line 3: Line 3:
 
* ''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''.
 
* ''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''.
 
* ''TCntrNodeObj cntr( )'' — returns the controller object regardless of the nesting parameters.
 
* ''TCntrNodeObj cntr( )'' — returns the controller object regardless of the nesting parameters.
−
* ''bool messSet( string mess, int lev, string type2Code = "OP", string cat = "")'' — sets of the DAQ-sourced message ''mess'' with the level ''lev'', for the parameter, whose name inserted hierarchically whether from the description field "'''MessName: {Name}'''" (even empty for hide) or from not empty name;
+
* ''bool messSet( string mess, int lev, string type2Code = "OP", string cat = "")'' — sets of the DAQ-sourced message ''mess'' with the level ''lev'', for the parameter, whose name inserted hierarchically to the text whether from the description field "'''MessName: {Name}'''" (even empty for hide) or from not empty name;
−
* ''bool alarmSet( string mess, int lev = -5, bool force = false )'' — sets/removes of the violation ''mess'' with the level ''lev'' (negative to set otherwise to remove) for the parameter, whose name inserted hierarchically whether from the description field "'''MessName: {Name}'''" (even empty for hide) or from not empty name. 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''.
+
* ''bool alarmSet( string mess, int lev = -5, bool force = false )'' — sets/removes of the violation ''mess'' with the level ''lev'' (negative to set otherwise to remove) for the parameter, whose name inserted hierarchically to the text whether from the description field "'''MessName: {Name}'''" (even empty for hide) or from not empty name. 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''.

Revision as of 10:34, 25 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 parameter object of the controller (SYS.DAQ["Modul"]["Controller"]["Parameter"]):
* ''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''.
* ''TCntrNodeObj cntr( )'' — returns the controller object regardless of the nesting parameters.
* ''bool messSet( string mess, int lev, string type2Code = "OP", string cat = "")'' — sets of the DAQ-sourced message ''mess'' with the level ''lev'', for the parameter, whose name inserted hierarchically to the text whether from the description field "'''MessName: {Name}'''" (even empty for hide) or from not empty name;
* ''bool alarmSet( string mess, int lev = -5, bool force = false )'' — sets/removes of the violation ''mess'' with the level ''lev'' (negative to set otherwise to remove) for the parameter, whose name inserted hierarchically to the text whether from the description field "'''MessName: {Name}'''" (even empty for hide) or from not empty name. 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''.
* ''bool attrAdd( string id, string name, string tp = "real", string selValsNms = "" )'' [<span style="color: red">for enabled dynamically controlled parameter</span>] — adds the attribute ''id'' with the name ''name'' and the type ''tp''. If the attribute is already present, the properties will be applied that can be changed on the go: name, selection mode and selection options.
** ''id, name'' — identifier and name of the new attribute;
** ''tp'' — attribute type [bool[ean] | int[eger] | real | string | text | object] + selection mode [sel | seled] + read-only [ro];
** ''selValsNms'' — two lines with values in first and their names in second, separated by ";".
* ''bool attrDel( string id )'' [<span style="color: red">for enabled dynamically controlled parameter</span>] — removes the attribute ''id''.
TranslationFunctions of the parameter object of the controller (SYS.DAQ["Modul"]["Controller"]["Parameter"]):
* ''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''.
* ''TCntrNodeObj cntr( )'' — returns the controller object regardless of the nesting parameters.
* ''bool messSet( string mess, int lev, string type2Code = "OP", string cat = "")'' — sets of the DAQ-sourced message ''mess'' with the level ''lev'', for the parameter, whose name inserted hierarchically to the text whether from the description field "'''MessName: {Name}'''" (even empty for hide) or from not empty name;
* ''bool alarmSet( string mess, int lev = -5, bool force = false )'' — sets/removes of the violation ''mess'' with the level ''lev'' (negative to set otherwise to remove) for the parameter, whose name inserted hierarchically to the text whether from the description field "'''MessName: {Name}'''" (even empty for hide) or from not empty name. 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''.

Functions of the parameter object of the controller (SYS.DAQ["Modul"]["Controller"]["Parameter"]):

  • ElTp cfg( string nm ) — gets the value of the configuration field nm of the object.
  • bool cfgSet( string nm, ElTp val ) [access to the appropriate subsystem] — sets the configuration field nm of the object to the value val.
  • TCntrNodeObj cntr( ) — returns the controller object regardless of the nesting parameters.
  • bool messSet( string mess, int lev, string type2Code = "OP", string cat = "") — sets of the DAQ-sourced message mess with the level lev, for the parameter, whose name inserted hierarchically to the text whether from the description field "MessName: {Name}" (even empty for hide) or from not empty name;
  • bool alarmSet( string mess, int lev = -5, bool force = false ) — sets/removes of the violation mess with the level lev (negative to set otherwise to remove) for the parameter, whose name inserted hierarchically to the text whether from the description field "MessName: {Name}" (even empty for hide) or from not empty name. 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.
Retrieved from "http://oscada.org/wiki/index.php?title=Translations:Documents/User_API/23/en&oldid=91579"