fwConfigs
8.4.2
|
Files | |
file | fwAlertConfig.ctl |
Alarm Settings object indexes | |
Used to access directly the alert settings object (object of type dyn_mixed). For advanced use. | |
const int | fwAlertConfig_ALERT_LIMIT_TEXT = 1 |
Text of the alarm range. More... | |
const int | fwAlertConfig_ALERT_LIMIT_VALUE = 2 |
Value of the alarm range. More... | |
const int | fwAlertConfig_ALERT_LIMIT_VALUE_INCLUDED = 3 |
Specify if the value of the alarm range must be included. More... | |
const int | fwAlertConfig_ALERT_LIMIT_CLASS = 4 |
Class of the alarm range. More... | |
const int | fwAlertConfig_ALERT_LIMIT_VALUE_MATCH = 5 |
Value to match for the alarm range. More... | |
const int | fwAlertConfig_ALERT_LIMIT_NEGATION = 8 |
If true, the value to match for the alarm range is negated. More... | |
const int | fwAlertConfig_ALERT_LIMIT_STATE_BITS = 9 |
State bits values that must match. More... | |
const int | fwAlertConfig_ALERT_LIMIT_LIMITS_STATE_BITS = 10 |
State bits values that must match for a specific range. More... | |
const int | fwAlertConfig_ALERT_LIMIT_TEXT_WENT = 11 |
Text of the alarm range. More... | |
const int | fwAlertConfig_ALERT_LIMIT_HYSTERESIS_UP = 12 |
Upper hysteresis limit. More... | |
const int | fwAlertConfig_ALERT_LIMIT_HYSTERESIS_LOW = 13 |
Lower hysteresis limit. More... | |
const int | fwAlertConfig_ALERT_PARAM_TYPE = 1 |
Type of alarm. More... | |
const int | fwAlertConfig_ALERT_PARAM_SUM_DPE_LIST = 2 |
List of DPEs in summary alerts. More... | |
const int | fwAlertConfig_ALERT_PARAM_ADD_DPE_TO_SUMMARY = 3 |
Add the new alert in a summary alert. More... | |
const int | fwAlertConfig_ALERT_PARAM_SUM_THRESHOLD = 4 |
Threshold filter parameter for the sum alerts. More... | |
const int | fwAlertConfig_ALERT_PARAM_PANEL = 5 |
Displays the file path of the panel. More... | |
const int | fwAlertConfig_ALERT_PARAM_IMPULSE = 9 |
set to true if impulse alarm More... | |
const int | fwAlertConfig_ALERT_PARAM_RANGES = 13 |
Number of alarm ranges. More... | |
const int | fwAlertConfig_ALERT_PARAM_ACTIVE = 14 |
alarm active More... | |
const int | fwAlertConfig_ALERT_PARAM = 1 |
const int | fwAlertConfig_ALERT_LIMIT = 2 |
Limits configuration object. More... | |
const int | fwAlertConfig_ALERT_PARAM_PANEL_PARAMETERS = 6 |
$-parameters to be passed when calling the panel More... | |
const int | fwAlertConfig_ALERT_PARAM_HELP = 7 |
Information concerning the alert. More... | |
const int | fwAlertConfig_ALERT_PARAM_DISCRETE = 8 |
Set to true if discrete alarm. More... | |
const int | fwAlertConfig_ALERT_PARAM_MODIFY_ONLY = 10 |
Set to true to modify alert without setting "type" attributes. More... | |
const int | fwAlertConfig_ALERT_PARAM_FALLBACK_TO_SET = 11 |
Used in combination with modifyOnly. More... | |
const int | fwAlertConfig_ALERT_PARAM_STORE_IN_HISTORY = 12 |
if the change should be stored in the Paramterisation History More... | |
Utility functions | |
Used to access the configuration object attributes (object of type dyn_mixed). | |
fwAlertConfig_objectInitialize (dyn_mixed ¶msObject, int totalRanges) | |
bool | fwAlertConfig_objectConfigExists (dyn_mixed alertConfigObject, int &configType, dyn_string &exceptionInfo) |
fwAlertConfig_objectCreateAnalog (dyn_mixed &alertConfigObject, dyn_string alertTexts, dyn_float alertLimits, dyn_string alertClasses, string alertPanel, dyn_string alertPanelParameters, string alertHelp, dyn_bool limitsIncluded, dyn_string &exceptionInfo, bool modifyOnly=FALSE, bool fallBackToSet=FALSE, string addDpeInSummary="", bool storeInParamHistory=TRUE) | |
fwAlertConfig_objectCreateDigital (dyn_mixed &alertConfigObject, dyn_string alertTexts, dyn_string alertClasses, string alertPanel, dyn_string alertPanelParameters, string alertHelp, dyn_string &exceptionInfo, bool modifyOnly=FALSE, bool fallBackToSet=FALSE, string addDpeInSummary="", bool storeInParamHistory=TRUE) | |
fwAlertConfig_objectCreateDiscrete (dyn_mixed &alertConfigObject, dyn_string alertTexts, dyn_string alertMatch, dyn_string alertClasses, string alertPanel, dyn_string alertPanelParameters, string alertHelp, bool impulse, dyn_bool discreteNegation, string stateBits, dyn_string stateMatch, dyn_string &exceptionInfo, bool modifyOnly=FALSE, bool fallBackToSet=FALSE, string addDpeInSummary="", bool storeInParamHistory=TRUE) | |
fwAlertConfig_objectCreateSummary (dyn_mixed &alertConfigObject, dyn_string alertTexts, int threshold, dyn_string alertClasses, dyn_string summaryDpeList, string alertPanel, dyn_string alertPanelParameters, string alertHelp, dyn_string &exceptionInfo, bool modifyOnly=FALSE, bool fallBackToSet=FALSE, string addDpeInSummary="", bool storeInParamHistory=TRUE) | |
fwAlertConfig_objectExtractAnalog (dyn_mixed alertConfigObject, int &alertType, dyn_string &alertTexts, dyn_float &alertLimits, dyn_string &alertClasses, string &alertPanel, dyn_string &alertPanelParameters, string &alertHelp, dyn_bool &limitsIncluded, bool &isActive, dyn_string &exceptionInfo) | |
fwAlertConfig_objectExtractType (dyn_mixed alertConfigObject, int &alertType, bool &isActive, dyn_string &exceptionInfo) | |
fwAlertConfig_objectExtractDiscrete (dyn_mixed alertConfigObject, int &alertType, dyn_string &alertTexts, dyn_string &alertMatches, dyn_string &alertClasses, string &alertPanel, dyn_string &alertPanelParameters, string &alertHelp, bool &isDiscrete, bool &impulse, dyn_bool &discreteNegation, string &stateBits, dyn_string &stateMatch, bool &isActive, dyn_string &exceptionInfo) | |
fwAlertConfig_objectExtractDigital (dyn_mixed alertConfigObject, int &alertType, dyn_string &alertTexts, dyn_string &alertClasses, string &alertPanel, dyn_string &alertPanelParameters, string &alertHelp, bool &isActive, dyn_string &exceptionInfo) | |
fwAlertConfig_objectExtractSummary (dyn_mixed alertConfigObject, int &alertType, dyn_string &alertTexts, dyn_string &summaryDpeList, int &threshold, string &alertClass, string &alertPanel, dyn_string &alertPanelParameters, string &alertHelp, bool &isActive, dyn_string &exceptionInfo) | |
Set/Get functions | |
Used to set/get the alarm settings to/from the dpe. The settings are stored into the settings object. | |
fwAlertConfig_objectSet (string dpe, dyn_mixed alertConfigObject, dyn_string &exceptionInfo) | |
fwAlertConfig_objectGet (string dpe, dyn_mixed &alertConfigObject, dyn_string &exceptionInfo) | |
fwAlertConfig_objectGetMany (dyn_string &dpes, dyn_dyn_mixed &alertConfigObjects, dyn_string &exceptionInfo) | |
fwAlertConfig_delete (string dpe, dyn_string &exceptionInfo, string removeDpeInSummary="", bool storeInParamHistory=TRUE) | |
fwAlertConfig_objectSetMany (dyn_string &dpes, dyn_dyn_mixed &alertConfigObjects, dyn_string &exceptionInfo) | |
bool | fwAlertConfig_isAlertFilteringActive () |
fwAlertConfig_deleteMultiple (dyn_string dpes, dyn_string &exceptionInfo, string removeDpeInSummary="", bool storeInParamHistory=TRUE) | |
fwAlertConfig_deleteMany (dyn_string dpes, dyn_string &exceptionInfo, string removeDpeInSummary="", bool storeInParamHistory=TRUE) | |
Activation functions | |
fwAlertConfig_acknowledge (string dpe, dyn_string &exceptionInfo, bool checkIfExists=TRUE, bool storeInParamHistory=FALSE) | |
fwAlertConfig_acknowledgeMany (dyn_string dpes, dyn_string &exceptionInfo, bool checkIfExists=TRUE, bool storeInParamHistory=FALSE) | |
fwAlertConfig_activate (string dpe, dyn_string &exceptionInfo, bool checkIfExists=TRUE, bool storeInParamHistory=FALSE) | |
fwAlertConfig_activateMultiple (dyn_string dpes, dyn_string &exceptionInfo, bool checkIfExists=TRUE, bool storeInParamHistory=FALSE) | |
fwAlertConfig_deactivate (string dpe, dyn_string &exceptionInfo, bool acknowledge=TRUE, bool checkIfExists=TRUE, bool storeInParamHistory=FALSE) | |
fwAlertConfig_deactivateMultiple (dyn_string dpes, dyn_string &exceptionInfo, bool acknowledge=TRUE, bool checkIfExists=TRUE, bool storeInParamHistory=FALSE) | |
The fwAlertConfigs library allows configuring alerts of type analog, discrete, boolean, summary.
The fwAlertConfigs library makes use of a configuration object. In order to configure a dpe with an alarm, the configuration setting object must be previously initialized with the alarm parameterization (using utility functions or directly accessing the object through the index constants). Such object is then passed to the set function that will make the necessary dpSet.
An analog alarm can be set in the following way: one should declare a configuration object of type dyn_anytype, then fill it with the alarm settings using the utility function fwAlertConfig_objectCreateAnalog(), then set the setting to the dpe using the function fwAlertConfig_objectSet().
Example: create an analog alert object (3 ranges) using the utility functions and set it to the dpe
For more examples, see the documentation for the function fwAlertConfig_objectSet().
A digital (bool) alarm can be set in the following way: one should declare a configuration object of type dyn_anytype, then fill it with the alarm settings using the utility function fwAlertConfig_objectCreateDigital(), then set the setting to the dpe using the function fwAlertConfig_objectSet().
Example: create a digital alert object (ok when true, alarm when false) using the utility functions and set it to the dpe
Example: create a digital alert object (ok when true, alarm when false)
An alarm can be also set accessing the parametrization object directly. This can be useful in case a user needs to use advanced features not available in the utility functions. One can declare a configuration object of type dyn_anytype, then fill it with the alarm settings accessing the items through the object indexes, then set the setting to the dpe using the function fwAlertConfig_objectSet().
Example: create a digital alert object (ok when false, alarm when true)
A discrete alarm can be set to types float, int and bit32. One should declare a configuration object of type dyn_anytype, then fill it with the alarm settings using the utility function fwAlertConfig_objectCreateDiscrete(), then set the setting to the dpe using the function fwAlertConfig_objectSet().
Example: create a discrete alert object (3 ranges) using the utility functions and set it to the dpe
For more examples, see the documentation for the function fwAlertConfig_objectSet().
An alarm can be also set accessing the parametrization object directly: one can declare a configuration object of type dyn_anytype, then fill it with the alarm settings accessing the items through the object indexes, then set the setting to the dpe using the function fwAlertConfig_objectSet().
Example: create a discrete alert object with 3 ranges and the basic parameters
For more examples, see the documentation for the function fwAlertConfig_objectSet().
An alarm can be also set accessing the parametrization object directly: one can declare a configuration object of type dyn_anytype, then fill it with the alarm settings accessing the items through the object indexes, then set the setting to the dpe using the function fwAlertConfig_objectSet().
Example: create a summary alert object
For more examples, see the documentation for the function fwAlertConfig_objectSet().
Alarms can be set in batch in the following way: one should declare a configuration object of type dyn_mixed (alarmObject). This object will be contained in an array of object (one object per dpe), of type dyn_mixed (call it alarmObjects). Each alarmObject then must be filled with the function fwAlertConfig_objectCreateAnalog(), and stored into the array of objects alarmObjects. The array of objects is then passed together with the array of dpes to the function fwAlertConfig_objectSetMany().
Example: create analog alert objects with 3 ranges and the basic parameters and set them to dpes
It is also possible to set many dpes with the same alarm settings. In this case, the array of settings objects must contain one only object, at the index 1. Example: set the same alarm into 2 dpes:
For more examples, see the documentation for the function fwAlertConfig_objectSetMany().
Alarm settings can be retrieved from a dpe in the following way: one should declare a configuration object of type dyn_mixed, then fill it with the alarm settings from the dpe using the function fwAlertConfig_objectGet(), then, in the case of an analog alert, extract the settings from the configuration object using the function fwAlertConfig_objectExtractAnalog().
Example: get an analog alarm from a dpe
Alarms can be retrieved in batch. This is much more performing than looping into the dpes with the function fwAlertConfig_objectGet(). The configuration objects will be contained in an array of object (one object per dpe), of type dyn_mixed (call it alertObjects). The array of objects alertObjects then must be filled with the function fwDpFunction_objectGetMany(). The array is the accessed in a loop, getting each element. The parameters can be then accessed using fwAlertConfig_objectExtractAnalog().
Example: get alarms from two dpes:
fwAlertConfig_objectInitialize | ( | dyn_mixed & | paramsObject, |
int | totalRanges | ||
) |
Set alarm object based on alarm params and limits. See note on fwAlertConfig_objectSet() for an example
paramsObject | object containing the alarm parameters and limits |
totalRanges | alarm ranges |
bool fwAlertConfig_objectConfigExists | ( | dyn_mixed | alertConfigObject, |
int & | configType, | ||
dyn_string & | exceptionInfo | ||
) |
Check if the paramaters object contains a configuration
alertConfigObject | Object containing the alarm config parameters |
configType | Returns the type of the current alert config in the object |
exceptionInfo | Details of any exceptions are returned here |
fwAlertConfig_objectCreateAnalog | ( | dyn_mixed & | alertConfigObject, |
dyn_string | alertTexts, | ||
dyn_float | alertLimits, | ||
dyn_string | alertClasses, | ||
string | alertPanel, | ||
dyn_string | alertPanelParameters, | ||
string | alertHelp, | ||
dyn_bool | limitsIncluded, | ||
dyn_string & | exceptionInfo, | ||
bool | modifyOnly = FALSE , |
||
bool | fallBackToSet = FALSE , |
||
string | addDpeInSummary = "" , |
||
bool | storeInParamHistory = TRUE |
||
) |
Creates a paramaters object for analog alarm.
alertConfigObject | Reference to the object to create |
alertTexts | Alert texts for each range eg. makeDynString( "Bad Text", "OK", "Bad Text") |
alertLimits | The limits of each range given here eg. makeDynFloat( 20, 60 ); Please note that the amount of limits is = amount of ranges-1. The object created will have an array containing the first limit as a fake limit. In this example, the values will be 0,20,60 (0 is a fake element just to fill the array). |
alertClasses | Alert classes for each range eg. makeDynString( "_fwErrorAck.", "" , "_fwErrorAck.") One of the items of the dyn_string must always be empty to indicate the valid state. The valid ranges becomes the state with no alert class given (the second in this case). Don't forget to add the dot to the alert class names. |
alertPanel | Panel to call from the alert screen |
alertPanelParameters | Parameters to pass to panel given in Alert Panel |
alertHelp | Help text or path to help file |
limitsIncluded | TRUE to include the limit (<=), FALSE else (<) eg. makeDynBool(TRUE,FALSE) for [<=20,<60]; Please note that the amount of limitsIncluded is = amount of ranges-1. The object created will have an array containing the first limitIncluded with a fake value. In this example, the values will be FALSE,TRUE,FALSE (the first FALSE is a fake element just to fill the array). |
exceptionInfo | Details of any exceptions are returned here |
modifyOnly | Optional parameter - Default value FALSE. Set to TRUE to modify alert without setting "type" attributes. This is much quicker, but the alert config must already exist, be an analog alert and have the same number of ranges as you want. |
fallBackToSet | Optional parameter - Default value FALSE. Used in combination with modifyOnly. If modifyOnly = TRUE and fallBackToSet = FALSE, then if the alert config is not compatible an exception is raised. If modifyOnly = TRUE and fallBackToSet = TRUE, then if the alert config is not compatible, modifyOnly is treated as if it was FALSE. |
addDpeInSummary | Optional parameter - Default value "". Used to add the new alert in a summary alert. Default value "" means do not add the new alert into a summary. You can specify either an absolute DPE name, or a relative path from the DP to which the new alert was saved. i.e. addDpeInSummary = "." will add the new alert on dpes[i] to the summary on the root of the datapoint to which dpes[i] belongs. addDpeInSummary = "MyDp.summaries" will add the new alert on dpes[i] to the summary on the dpe called "MyDp.summaries". Note: The summary alarms must already exist. If they does not exist, it WILL NOT be created. |
storeInParamHistory | OPTIONAL PARAMETER - default value = TRUE You can specify if the change should be stored in the Paramterisation History of PVSS |
fwAlertConfig_objectCreateDigital | ( | dyn_mixed & | alertConfigObject, |
dyn_string | alertTexts, | ||
dyn_string | alertClasses, | ||
string | alertPanel, | ||
dyn_string | alertPanelParameters, | ||
string | alertHelp, | ||
dyn_string & | exceptionInfo, | ||
bool | modifyOnly = FALSE , |
||
bool | fallBackToSet = FALSE , |
||
string | addDpeInSummary = "" , |
||
bool | storeInParamHistory = TRUE |
||
) |
Creates a paramaters object for digital alarm. The object is set to the alarm using fwAlertConfig_objectSet
alertConfigObject | Reference to the object to create |
alertTexts | Alert texts for each range eg. makeDynString( "Bad Text", "OK", "Bad Text") |
alertClasses | Alert classes for each range eg. makeDynString( "" , "_fwErrorAck.") One of the items of the dyn_string must always be empty to indicate the valid state. eg. makeDynString( "" , "_fwErrorAck.") for FALSE to be good state, makeDynString( "_fwErrorAck." , "") for TRUE to be good state. Don't forget to add the dot to the alert class names. |
alertPanel | Panel to call from the alert screen |
alertPanelParameters | Parameters to pass to panel given in Alert Panel |
alertHelp | Help text or path to help file |
exceptionInfo | Details of any exceptions are returned here |
modifyOnly | Optional parameter - Default value FALSE. Set to TRUE to modify alert without setting "type" attributes. This is much quicker, but the alert config must already exist, be an analog alert and have the same number of ranges as you want. |
fallBackToSet | Optional parameter - Default value FALSE. Used in combination with modifyOnly. If modifyOnly = TRUE and fallBackToSet = FALSE, then if the alert config is not compatible an exception is raised. If modifyOnly = TRUE and fallBackToSet = TRUE, then if the alert config is not compatible, modifyOnly is treated as if it was FALSE. |
addDpeInSummary | Optional parameter - Default value "". Used to add the new alert in a summary alert. Default value "" means do not add the new alert into a summary. You can specify either an absolute DPE name, or a relative path from the DP to which the new alert was saved. i.e. addDpeInSummary = "." will add the new alert on dpes[i] to the summary on the root of the datapoint to which dpes[i] belongs. addDpeInSummary = "MyDp.summaries" will add the new alert on dpes[i] to the summary on the dpe called "MyDp.summaries". Note: The summary alarms must already exist. If they does not exist, it WILL NOT be created. |
storeInParamHistory | OPTIONAL PARAMETER - default value = TRUE You can specify if the change should be stored in the Paramterisation History of PVSS |
fwAlertConfig_objectCreateDiscrete | ( | dyn_mixed & | alertConfigObject, |
dyn_string | alertTexts, | ||
dyn_string | alertMatch, | ||
dyn_string | alertClasses, | ||
string | alertPanel, | ||
dyn_string | alertPanelParameters, | ||
string | alertHelp, | ||
bool | impulse, | ||
dyn_bool | discreteNegation, | ||
string | stateBits, | ||
dyn_string | stateMatch, | ||
dyn_string & | exceptionInfo, | ||
bool | modifyOnly = FALSE , |
||
bool | fallBackToSet = FALSE , |
||
string | addDpeInSummary = "" , |
||
bool | storeInParamHistory = TRUE |
||
) |
Creates a paramaters object for digital discrete or analog discrete alarm. The object is set to the alarm using fwAlertConfig_objectSet
alertConfigObject | Reference to the object to create |
alertTexts | Alert texts for each range. the first one is always the good one eg. makeDynString( "Ok", "Bad Text", "Bad Text") |
alertMatch | Alert values that must match. Can be one value, a list of values or a range of values. The first value is always "*" e.g. makedynString( "*","1,2","5-10") |
alertClasses | Alert classes for each range eg. makeDynString( "" , "_fwErrorAck.") One of the items of the dyn_string must always be empty to indicate the valid state. eg. makeDynString( "" , "_fwErrorAck.") for FALSE to be good state, makeDynString( "_fwErrorAck." , "") for TRUE to be good state. Don't forget to add the dot to the alert class names. |
alertPanel | Panel to call from the alert screen |
alertPanelParameters | Parameters to pass to panel given in Alert Panel |
alertHelp | Help text or path to help file |
impulse | TRUE if alert is impulse alert else FALSE |
discreteNegation | for each match values, TRUE if the match is negated (i.e. "!="). |
stateBits | state bits of the discrete alert |
stateMatch | state bits of each value match |
exceptionInfo | Details of any exceptions are returned here |
modifyOnly | Optional parameter - Default value FALSE. Set to TRUE to modify alert without setting "type" attributes. This is much quicker, but the alert config must already exist, be an analog alert and have the same number of ranges as you want. |
fallBackToSet | Optional parameter - Default value FALSE. Used in combination with modifyOnly. If modifyOnly = TRUE and fallBackToSet = FALSE, then if the alert config is not compatible an exception is raised. If modifyOnly = TRUE and fallBackToSet = TRUE, then if the alert config is not compatible, modifyOnly is treated as if it was FALSE. |
addDpeInSummary | Optional parameter - Default value "". Used to add the new alert in a summary alert. Default value "" means do not add the new alert into a summary. You can specify either an absolute DPE name, or a relative path from the DP to which the new alert was saved. i.e. addDpeInSummary = "." will add the new alert on dpes[i] to the summary on the root of the datapoint to which dpes[i] belongs. addDpeInSummary = "MyDp.summaries" will add the new alert on dpes[i] to the summary on the dpe called "MyDp.summaries". Note: The summary alarms must already exist. If they does not exist, it WILL NOT be created. |
storeInParamHistory | OPTIONAL PARAMETER - default value = TRUE You can specify if the change should be stored in the Paramterisation History of PVSS |
fwAlertConfig_objectCreateSummary | ( | dyn_mixed & | alertConfigObject, |
dyn_string | alertTexts, | ||
int | threshold, | ||
dyn_string | alertClasses, | ||
dyn_string | summaryDpeList, | ||
string | alertPanel, | ||
dyn_string | alertPanelParameters, | ||
string | alertHelp, | ||
dyn_string & | exceptionInfo, | ||
bool | modifyOnly = FALSE , |
||
bool | fallBackToSet = FALSE , |
||
string | addDpeInSummary = "" , |
||
bool | storeInParamHistory = TRUE |
||
) |
Creates a paramaters object for summary alarm. The object is set to the alarm using fwAlertConfig_objectSet().
alertConfigObject | Reference to the object to create |
alertTexts | Alert texts for each range eg. makeDynString( "Bad Text", "OK", "Bad Text") |
threshold | How many single alarms must be triggered before they are filtered (i.e. not visible) by the summary alarm. |
alertClasses | Alert classes for each range eg. makeDynString( "" , "_fwErrorAck.") One of the items of the dyn_string must always be empty to indicate the valid state. eg. makeDynString( "" , "_fwErrorAck.") for FALSE to be good state, makeDynString( "_fwErrorAck." , "") for TRUE to be good state. Don't forget to add the dot to the alert class names. |
summaryDpeList | List of dpes to include in summary alert |
alertPanel | Panel to call from the alert screen |
alertPanelParameters | Parameters to pass to panel given in Alert Panel |
alertHelp | Help text or path to help file |
exceptionInfo | Details of any exceptions are returned here |
modifyOnly | Optional parameter - Default value FALSE. Set to TRUE to modify alert without setting "type" attributes. This is much quicker, but the alert config must already exist, be an analog alert and have the same number of ranges as you want. |
fallBackToSet | Optional parameter - Default value FALSE. Used in combination with modifyOnly. If modifyOnly = TRUE and fallBackToSet = FALSE, then if the alert config is not compatible an exception is raised. If modifyOnly = TRUE and fallBackToSet = TRUE, then if the alert config is not compatible, modifyOnly is treated as if it was FALSE. |
addDpeInSummary | Optional parameter - Default value "". Used to add the new alert in a summary alert. Default value "" means do not add the new alert into a summary. You can specify either an absolute DPE name, or a relative path from the DP to which the new alert was saved. i.e. addDpeInSummary = "." will add the new alert on dpes[i] to the summary on the root of the datapoint to which dpes[i] belongs. addDpeInSummary = "MyDp.summaries" will add the new alert on dpes[i] to the summary on the dpe called "MyDp.summaries". Note: The summary alarms must already exist. If they does not exist, it WILL NOT be created. |
storeInParamHistory | OPTIONAL PARAMETER - default value = TRUE You can specify if the change should be stored in the Paramterisation History of PVSS |
fwAlertConfig_objectExtractAnalog | ( | dyn_mixed | alertConfigObject, |
int & | alertType, | ||
dyn_string & | alertTexts, | ||
dyn_float & | alertLimits, | ||
dyn_string & | alertClasses, | ||
string & | alertPanel, | ||
dyn_string & | alertPanelParameters, | ||
string & | alertHelp, | ||
dyn_bool & | limitsIncluded, | ||
bool & | isActive, | ||
dyn_string & | exceptionInfo | ||
) |
Returns the details of an analog alert configuration in a parameter object preivously filled.
alertConfigObject | object from where to extract the parameters |
alertType | Type of alert: DPCONFIG_ALERT_BINARYSIGNAL if digital alert handling DPCONFIG_ALERT_NONBINARYSIGNAL if analog alert handling DPCONFIG_SUM_ALERT if summary alert handling DPCONFIG_NONE if no alert handling |
alertTexts | Alert texts are returned here |
alertLimits | Alert limits are returned here |
alertClasses | Alert classes are returned here |
alertPanel | Panel to call from the alert screen |
alertPanelParameters | Parameters to pass to the given alertPanel |
alertHelp | Help text or path to help file |
limitsIncluded | if the limit is included (<=) or excluded (<) |
isActive | if alert is active |
exceptionInfo | Details of any exceptions are returned here |
fwAlertConfig_objectExtractType | ( | dyn_mixed | alertConfigObject, |
int & | alertType, | ||
bool & | isActive, | ||
dyn_string & | exceptionInfo | ||
) |
Returns the type of alert configuration in a parameter object preivously filled.
alertConfigObject | object from where to extract the parameters |
alertType | Type of alert: DPCONFIG_ALERT_BINARYSIGNAL if digital alert handling DPCONFIG_ALERT_NONBINARYSIGNAL if analog alert handling DPCONFIG_SUM_ALERT if summary alert handling DPCONFIG_NONE if no alert handling |
isActive | if alert is active |
exceptionInfo | Details of any exceptions are returned here |
fwAlertConfig_objectExtractDiscrete | ( | dyn_mixed | alertConfigObject, |
int & | alertType, | ||
dyn_string & | alertTexts, | ||
dyn_string & | alertMatches, | ||
dyn_string & | alertClasses, | ||
string & | alertPanel, | ||
dyn_string & | alertPanelParameters, | ||
string & | alertHelp, | ||
bool & | isDiscrete, | ||
bool & | impulse, | ||
dyn_bool & | discreteNegation, | ||
string & | stateBits, | ||
dyn_string & | stateMatch, | ||
bool & | isActive, | ||
dyn_string & | exceptionInfo | ||
) |
Returns the details of a discrete alert configuration in a parameter object preivously filled.
alertConfigObject | object from where to extract the parameters |
alertType | Type of alert: DPCONFIG_ALERT_BINARYSIGNAL if digital alert handling DPCONFIG_ALERT_NONBINARYSIGNAL if analog alert handling DPCONFIG_NONE if no alert handling |
alertTexts | Alert texts are returned here |
alertMatches | Alert limits are returned here |
alertClasses | Alert classes are returned here |
alertPanel | Panel to call from the alert screen |
alertPanelParameters | Parameters to pass to the given alertPanel |
alertHelp | Help text or path to help file |
isDiscrete | TRUE if the alert is discrete |
impulse | TRUE if alert is impulse alert else FALSE |
discreteNegation | for each match values, TRUE if the match is negated (i.e. "!="). |
stateBits | state bits of the discrete alert |
stateMatch | state bits of each value match |
isActive | if alert is active |
exceptionInfo | Details of any exceptions are returned here |
fwAlertConfig_objectExtractDigital | ( | dyn_mixed | alertConfigObject, |
int & | alertType, | ||
dyn_string & | alertTexts, | ||
dyn_string & | alertClasses, | ||
string & | alertPanel, | ||
dyn_string & | alertPanelParameters, | ||
string & | alertHelp, | ||
bool & | isActive, | ||
dyn_string & | exceptionInfo | ||
) |
Returns the details of a digital alert configuration in a parameter object preivously filled.
alertConfigObject | object from where to extract the parameters |
alertType | Type of alert: DPCONFIG_ALERT_BINARYSIGNAL if digital alert handling DPCONFIG_ALERT_NONBINARYSIGNAL if analog alert handling DPCONFIG_SUM_ALERT if summary alert handling DPCONFIG_NONE if no alert handling |
alertTexts | Alert texts are returned here |
alertClasses | Alert classes are returned here |
alertPanel | Panel to call from the alert screen |
alertPanelParameters | Parameters to pass to the given alertPanel |
alertHelp | Help text or path to help file |
isActive | if alert is active |
exceptionInfo | Details of any exceptions are returned here |
fwAlertConfig_objectExtractSummary | ( | dyn_mixed | alertConfigObject, |
int & | alertType, | ||
dyn_string & | alertTexts, | ||
dyn_string & | summaryDpeList, | ||
int & | threshold, | ||
string & | alertClass, | ||
string & | alertPanel, | ||
dyn_string & | alertPanelParameters, | ||
string & | alertHelp, | ||
bool & | isActive, | ||
dyn_string & | exceptionInfo | ||
) |
Returns the details of a summary alert configuration in a parameter object preivously filled.
alertConfigObject | object from where to extract the parameters |
alertType | Type of alert: DPCONFIG_ALERT_BINARYSIGNAL if digital alert handling DPCONFIG_ALERT_NONBINARYSIGNAL if analog alert handling DPCONFIG_SUM_ALERT if summary alert handling DPCONFIG_NONE if no alert handling |
alertTexts | Alert texts are returned here |
threshold | How many single alarms must be triggered before they are filtered (i.e. not visible) by the summary alarm. |
summaryDpeList | List of dpes to include in summary alert |
alertClass | Alert classes are returned here |
alertPanel | Panel to call from the alert screen |
alertPanelParameters | Parameters to pass to the given alertPanel |
alertHelp | Help text or path to help file |
isActive | if alert is active |
exceptionInfo | Details of any exceptions are returned here |
fwAlertConfig_objectSet | ( | string | dpe, |
dyn_mixed | alertConfigObject, | ||
dyn_string & | exceptionInfo | ||
) |
Set the alert with the alert parameter object. The alert parameter object must be previously filled. The object is a dyn_mixed variable. It is made of two dyn_dyn_mixed sub-variables:
How to fill the parameters object: use one of the functions "fwAlertConfig_objectCreate..." or fill it manually as in the examples given here:
dpe | the datapoint element to configure |
alertConfigObject | object from where to extract the parameters |
exceptionInfo | Details of any exceptions are returned here |
fwAlertConfig_objectGet | ( | string | dpe, |
dyn_mixed & | alertConfigObject, | ||
dyn_string & | exceptionInfo | ||
) |
Returns the details of any alert configuration on a given dpe. This function can handle digital, analog and summary alerts. For more info refer to fwAlertConfig_objectSet()
dpe | Name of data point element to read from |
alertConfigObject | returns the object containing the parameters and the limits objects of the alarm. |
exceptionInfo | Details of any exceptions are returned here |
fwAlertConfig_objectGetMany | ( | dyn_string & | dpes, |
dyn_dyn_mixed & | alertConfigObjects, | ||
dyn_string & | exceptionInfo | ||
) |
Get alarm based on alarm params and limits objects. For further info on how to handle alertConfigObjects, refer to the examples in fwAlertConfig_objectSet()
dpes | Names of data point elements to read from. It is passed as reference only for performance reasons. It is not modified. |
alertConfigObjects | returns the objects containing the parameters and the limits objects of the alarm. |
exceptionInfo | Details of any exceptions are returned here |
fwAlertConfig_delete | ( | string | dpe, |
dyn_string & | exceptionInfo, | ||
string | removeDpeInSummary = "" , |
||
bool | storeInParamHistory = TRUE |
||
) |
Deletes the alert config for the given data point element
dpe | data point element |
exceptionInfo | details of any errors are returned here |
removeDpeInSummary | OPTIONAL PARAMETER - default value = "" (no aciton) You can specify the dpe which has a summary alert from which you want to remove the reference to the dpe to delete |
storeInParamHistory | OPTIONAL PARAMETER - default value = TRUE You can specify if the change should be stored in the Paramterisation History of PVSS |
fwAlertConfig_acknowledge | ( | string | dpe, |
dyn_string & | exceptionInfo, | ||
bool | checkIfExists = TRUE , |
||
bool | storeInParamHistory = FALSE |
||
) |
Acknowledges the alert handling on the given data point element. This function uses the DPATTR_ACKTYPE_SINGLE to acknowledge the alert.
dpe | Data point element to act on |
exceptionInfo | Details of any exceptions are returned here |
checkIfExists | Optional parameter (Default value - TRUE) TRUE - check if alert config exists (avoids errors if it doesn't) FALSE - do not check if alert exists (may cause errors if it does not exist) |
storeInParamHistory | OPTIONAL PARAMETER - default value = TRUE You can specify if the change should be stored in the Paramterisation History of PVSS |
fwAlertConfig_acknowledgeMany | ( | dyn_string | dpes, |
dyn_string & | exceptionInfo, | ||
bool | checkIfExists = TRUE , |
||
bool | storeInParamHistory = FALSE |
||
) |
Acknowledges the alert handling on the given data point elements. If more than one dpe is specified, the DPATTR_ACKTYPE_MULTIPLE value is used to acknowledge, indicating that the alerts were acknowledged as part of a group acknowledge action. Otherwise the DPATTR_ACKTYPE_SINGLE value is written.
dpes | the list of data point elements to act on |
exceptionInfo | Details of any exceptions are returned here |
checkIfExists | Optional parameter (Default value - TRUE) TRUE - only acknowledge alerts which exist (avoids errors if it doesn't) FALSE - do not check if alert exists (cause exceptions to be raised if they do not exist) |
storeInParamHistory | OPTIONAL PARAMETER - default value = TRUE You can specify if the change should be stored in the Paramterisation History of PVSS |
fwAlertConfig_activate | ( | string | dpe, |
dyn_string & | exceptionInfo, | ||
bool | checkIfExists = TRUE , |
||
bool | storeInParamHistory = FALSE |
||
) |
Activates the alert handling on the given data point element.
dpe | Data point element to act on |
exceptionInfo | Details of any exceptions are returned here |
checkIfExists | Optional parameter (Default value - TRUE) TRUE - check if alert config exists (avoids errors if it doesn't) FALSE - do not check if alert exists (may cause errors if it does not exist) |
storeInParamHistory | Optional parameter (Default value - FALSE) TRUE - writing to active bit is stored in alert history FALSE - writing to active bit is not stored in alert history |
fwAlertConfig_activateMultiple | ( | dyn_string | dpes, |
dyn_string & | exceptionInfo, | ||
bool | checkIfExists = TRUE , |
||
bool | storeInParamHistory = FALSE |
||
) |
Activates the alert handling on the given list of data point elements.
dpes | The list of data point elements to act on |
exceptionInfo | Details of any exceptions are returned here |
checkIfExists | Optional parameter (Default value - TRUE) TRUE - check if alert config exists (avoids errors if it doesn't) FALSE - do not check if alert exists (may cause errors if it does not exist) |
storeInParamHistory | Optional parameter (Default value - FALSE) TRUE - writing to active bit is stored in alert history FALSE - writing to active bit is not stored in alert history |
fwAlertConfig_deactivate | ( | string | dpe, |
dyn_string & | exceptionInfo, | ||
bool | acknowledge = TRUE , |
||
bool | checkIfExists = TRUE , |
||
bool | storeInParamHistory = FALSE |
||
) |
Deactivates the alert handling on the given data point element.
dpe | Data point element to act on |
exceptionInfo | Details of any exceptions are returned here |
acknowledge | Optional parameter (Default value - TRUE) TRUE for acknowledge alert when deactivating FALSE to leave alert unacknowledge when deactivated |
checkIfExists | Optional parameter (Default value - TRUE) TRUE - check if alert config exists (avoids errors if it doesn't) FALSE - do not check if alert exists (may cause errors if it does not exist) |
storeInParamHistory | Optional parameter (Default value - FALSE) TRUE - writing to active bit is stored in alert history FALSE - writing to active bit is not stored in alert history |
fwAlertConfig_deactivateMultiple | ( | dyn_string | dpes, |
dyn_string & | exceptionInfo, | ||
bool | acknowledge = TRUE , |
||
bool | checkIfExists = TRUE , |
||
bool | storeInParamHistory = FALSE |
||
) |
Deactivates the alert handling on the given list of data point elements.
dpes | List of data point elements to act on |
exceptionInfo | Details of any exceptions are returned here |
acknowledge | Optional parameter (Default value - TRUE) TRUE for acknowledge alert when deactivating FALSE to leave alert unacknowledge when deactivated |
checkIfExists | Optional parameter (Default value - TRUE) TRUE - check if alert config exists (avoids errors if it doesn't) FALSE - do not check if alert exists (may cause errors if it does not exist) |
storeInParamHistory | Optional parameter (Default value - FALSE) TRUE - writing to active bit is stored in alert history FALSE - writing to active bit is not stored in alert history |
fwAlertConfig_objectSetMany | ( | dyn_string & | dpes, |
dyn_dyn_mixed & | alertConfigObjects, | ||
dyn_string & | exceptionInfo | ||
) |
Set the alert with the alert parameter object alertConfigObject. The alert parameter object must be previously filled. How to fill it: fill each elemt of the array alertConfigObject[i] using one of the functions "fwAlertConfig_objectCreate..." or fill it manually as in the examples given for fwAlertConfig_objectSet()
One object per dpe must be filled. Optionally, one only object (index 1) can be filled and several dpes can be passed. In such case, the function sets the same object to all the dpes. In this case, the dpes must all be of the same type.
This function is more efficient that applying the function fwAlertConfig_objectSet() in a loop.
dpes | list of datapoint elements to configure. It is passed as reference only for performance reasons. It is not modified. |
alertConfigObjects | list of objects from where to extract the parameters. The amount of alarm configuration objects must match the amount of dpes. Alternatively, if the number of alarm configuration objects is only one, that configuration is then applied to all the dpes in the list. Passed as reference only for performance reasons. Not modified. |
exceptionInfo | Details of any exceptions are returned here |
bool fwAlertConfig_isAlertFilteringActive | ( | ) |
Check if alert filtereing is configured through the config file
The function is a functional replacement for the isAlertFileringActive() which is delivered by aes.ctl (yet loading it pulls in lots of other depencencies).
fwAlertConfig_deleteMultiple | ( | dyn_string | dpes, |
dyn_string & | exceptionInfo, | ||
string | removeDpeInSummary = "" , |
||
bool | storeInParamHistory = TRUE |
||
) |
Deletes the alert config for the given data point elements
dpes | list of data point elements |
exceptionInfo | details of any errors are returned here |
removeDpeInSummary | OPTIONAL PARAMETER - default value = "" (no aciton) You can specify the dpe which has a summary alert from which you want to remove the reference to the dpe to delete |
storeInParamHistory | OPTIONAL PARAMETER - default value = TRUE You can specify if the change should be stored in the Paramterisation History of PVSS |
fwAlertConfig_deleteMany | ( | dyn_string | dpes, |
dyn_string & | exceptionInfo, | ||
string | removeDpeInSummary = "" , |
||
bool | storeInParamHistory = TRUE |
||
) |
Deletes the alert config for the given data point elements
dpes | list of data point elements |
exceptionInfo | details of any errors are returned here |
removeDpeInSummary | OPTIONAL PARAMETER - default value = "" (no aciton) You can specify the dpe which has a summary alert from which you want to remove the reference to the dpe to delete |
storeInParamHistory | OPTIONAL PARAMETER - default value = TRUE You can specify if the change should be stored in the Paramterisation History of PVSS |
const int fwAlertConfig_ALERT_LIMIT_TEXT = 1 |
Text of the alarm range.
const int fwAlertConfig_ALERT_LIMIT_VALUE = 2 |
Value of the alarm range.
const int fwAlertConfig_ALERT_LIMIT_VALUE_INCLUDED = 3 |
Specify if the value of the alarm range must be included.
const int fwAlertConfig_ALERT_LIMIT_CLASS = 4 |
Class of the alarm range.
const int fwAlertConfig_ALERT_LIMIT_VALUE_MATCH = 5 |
Value to match for the alarm range.
const int fwAlertConfig_ALERT_LIMIT_NEGATION = 8 |
If true, the value to match for the alarm range is negated.
const int fwAlertConfig_ALERT_LIMIT_STATE_BITS = 9 |
State bits values that must match.
const int fwAlertConfig_ALERT_LIMIT_LIMITS_STATE_BITS = 10 |
State bits values that must match for a specific range.
const int fwAlertConfig_ALERT_LIMIT_TEXT_WENT = 11 |
Text of the alarm range.
const int fwAlertConfig_ALERT_LIMIT_HYSTERESIS_UP = 12 |
Upper hysteresis limit.
const int fwAlertConfig_ALERT_LIMIT_HYSTERESIS_LOW = 13 |
Lower hysteresis limit.
const int fwAlertConfig_ALERT_PARAM_TYPE = 1 |
Type of alarm.
const int fwAlertConfig_ALERT_PARAM_SUM_DPE_LIST = 2 |
List of DPEs in summary alerts.
const int fwAlertConfig_ALERT_PARAM_ADD_DPE_TO_SUMMARY = 3 |
Add the new alert in a summary alert.
const int fwAlertConfig_ALERT_PARAM_SUM_THRESHOLD = 4 |
Threshold filter parameter for the sum alerts.
const int fwAlertConfig_ALERT_PARAM_PANEL = 5 |
Displays the file path of the panel.
const int fwAlertConfig_ALERT_PARAM_IMPULSE = 9 |
set to true if impulse alarm
const int fwAlertConfig_ALERT_PARAM_RANGES = 13 |
Number of alarm ranges.
const int fwAlertConfig_ALERT_PARAM_ACTIVE = 14 |
alarm active
const int fwAlertConfig_ALERT_PARAM = 1 |
const int fwAlertConfig_ALERT_LIMIT = 2 |
Limits configuration object.
const int fwAlertConfig_ALERT_PARAM_PANEL_PARAMETERS = 6 |
$-parameters to be passed when calling the panel
const int fwAlertConfig_ALERT_PARAM_HELP = 7 |
Information concerning the alert.
const int fwAlertConfig_ALERT_PARAM_DISCRETE = 8 |
Set to true if discrete alarm.
const int fwAlertConfig_ALERT_PARAM_MODIFY_ONLY = 10 |
Set to true to modify alert without setting "type" attributes.
const int fwAlertConfig_ALERT_PARAM_FALLBACK_TO_SET = 11 |
Used in combination with modifyOnly.
const int fwAlertConfig_ALERT_PARAM_STORE_IN_HISTORY = 12 |
if the change should be stored in the Paramterisation History