fwConfigs  8.4.2
fwAlertConfig

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 &paramsObject, 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

Used to activate, deactivate, acknowledge alarms.

 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)
 

Detailed Description

The fwAlertConfigs library allows configuring alerts of type analog, discrete, boolean, summary.

Use Examples

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.

Setting an analog alarm

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().

Setting an alarm of type Digital (bool)

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)

Setting a discrete alert

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().

Setting a discrete alert without the use of utility function

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().

Setting summary alert

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().

Setting many alarms

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().

Getting an alarm

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

Getting many alarms

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:

Function Documentation

fwAlertConfig_objectInitialize ( dyn_mixed &  paramsObject,
int  totalRanges 
)

Set alarm object based on alarm params and limits. See note on fwAlertConfig_objectSet() for an example

Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
paramsObjectobject containing the alarm parameters and limits
totalRangesalarm ranges
bool fwAlertConfig_objectConfigExists ( dyn_mixed  alertConfigObject,
int &  configType,
dyn_string &  exceptionInfo 
)

Check if the paramaters object contains a configuration

Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
alertConfigObjectObject containing the alarm config parameters
configTypeReturns the type of the current alert config in the object
exceptionInfoDetails of any exceptions are returned here
Returns
TRUE if the configuration is present, FALSE else.
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.

  • example: creating an object with an analog alarm with 3 ranges
Constraints
not for discrete alarms
Usage
Public
PVSS managers
VISION, CTRL
Parameters
alertConfigObjectReference to the object to create
alertTextsAlert texts for each range eg. makeDynString( "Bad Text", "OK", "Bad Text")
alertLimitsThe 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).
alertClassesAlert 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.
alertPanelPanel to call from the alert screen
alertPanelParametersParameters to pass to panel given in Alert Panel
alertHelpHelp text or path to help file
limitsIncludedTRUE 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).
exceptionInfoDetails of any exceptions are returned here
modifyOnlyOptional 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.
fallBackToSetOptional 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.
addDpeInSummaryOptional 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.
storeInParamHistoryOPTIONAL PARAMETER - default value = TRUE You can specify if the change should be stored in the Paramterisation History of PVSS
See Also
fwAlertConfig_objectCreateDiscrete(), fwAlertConfig_objectCreateDigital(), fwAlertConfig_objectCreateSummary()
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

  • example: creating an object with a digital alarm with FALSE ("cool") as good range:
Constraints
not for discrete alarms
Usage
Public
PVSS managers
VISION, CTRL
Parameters
alertConfigObjectReference to the object to create
alertTextsAlert texts for each range eg. makeDynString( "Bad Text", "OK", "Bad Text")
alertClassesAlert 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.
alertPanelPanel to call from the alert screen
alertPanelParametersParameters to pass to panel given in Alert Panel
alertHelpHelp text or path to help file
exceptionInfoDetails of any exceptions are returned here
modifyOnlyOptional 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.
fallBackToSetOptional 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.
addDpeInSummaryOptional 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.
storeInParamHistoryOPTIONAL PARAMETER - default value = TRUE You can specify if the change should be stored in the Paramterisation History of PVSS
See Also
fwAlertConfig_objectCreateAnalog(), fwAlertConfig_objectCreateDiscrete(), fwAlertConfig_objectCreateSummary()
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

  • example: creating an object with an analog discrete alarm with 3 ranges:
Constraints
not for discrete alarms
Usage
Public
PVSS managers
VISION, CTRL
Parameters
alertConfigObjectReference to the object to create
alertTextsAlert texts for each range. the first one is always the good one eg. makeDynString( "Ok", "Bad Text", "Bad Text")
alertMatchAlert 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")
alertClassesAlert 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.
alertPanelPanel to call from the alert screen
alertPanelParametersParameters to pass to panel given in Alert Panel
alertHelpHelp text or path to help file
impulseTRUE if alert is impulse alert else FALSE
discreteNegationfor each match values, TRUE if the match is negated (i.e. "!=").
stateBitsstate bits of the discrete alert
stateMatchstate bits of each value match
exceptionInfoDetails of any exceptions are returned here
modifyOnlyOptional 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.
fallBackToSetOptional 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.
addDpeInSummaryOptional 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.
storeInParamHistoryOPTIONAL PARAMETER - default value = TRUE You can specify if the change should be stored in the Paramterisation History of PVSS
See Also
fwAlertConfig_objectCreateAnalog(), fwAlertConfig_objectCreateDigital(), fwAlertConfig_objectCreateSummary()
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().

  • example: creating an object with a summary alarm with a list of 3 dpes, filtering the single alarms if more than 2:
Constraints
although existing in the parameter list, the alert class cannot be set not for discrete alarms
Usage
Public
PVSS managers
VISION, CTRL
Parameters
alertConfigObjectReference to the object to create
alertTextsAlert texts for each range eg. makeDynString( "Bad Text", "OK", "Bad Text")
thresholdHow many single alarms must be triggered before they are filtered (i.e. not visible) by the summary alarm.
alertClassesAlert 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.
summaryDpeListList of dpes to include in summary alert
alertPanelPanel to call from the alert screen
alertPanelParametersParameters to pass to panel given in Alert Panel
alertHelpHelp text or path to help file
exceptionInfoDetails of any exceptions are returned here
modifyOnlyOptional 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.
fallBackToSetOptional 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.
addDpeInSummaryOptional 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.
storeInParamHistoryOPTIONAL PARAMETER - default value = TRUE You can specify if the change should be stored in the Paramterisation History of PVSS
See Also
fwAlertConfig_objectCreateAnalog(), fwAlertConfig_objectCreateDiscrete(), fwAlertConfig_objectCreateDigital()
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.

  • example: get an analog alarm from a dpe
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
alertConfigObjectobject from where to extract the parameters
alertTypeType 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
alertTextsAlert texts are returned here
alertLimitsAlert limits are returned here
alertClassesAlert classes are returned here
alertPanelPanel to call from the alert screen
alertPanelParametersParameters to pass to the given alertPanel
alertHelpHelp text or path to help file
limitsIncludedif the limit is included (<=) or excluded (<)
isActiveif alert is active
exceptionInfoDetails of any exceptions are returned here
See Also
fwAlertConfig_objectExtractDiscrete(), fwAlertConfig_objectExtractDigital(), fwAlertConfig_objectExtractSummary()
fwAlertConfig_objectExtractType ( dyn_mixed  alertConfigObject,
int &  alertType,
bool &  isActive,
dyn_string &  exceptionInfo 
)

Returns the type of alert configuration in a parameter object preivously filled.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
alertConfigObjectobject from where to extract the parameters
alertTypeType 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
isActiveif alert is active
exceptionInfoDetails of any exceptions are returned here
See Also
fwAlertConfig_objectExtractDiscrete(), fwAlertConfig_objectExtractDigital(), fwAlertConfig_objectExtractSummary()
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.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
alertConfigObjectobject from where to extract the parameters
alertTypeType of alert: DPCONFIG_ALERT_BINARYSIGNAL if digital alert handling DPCONFIG_ALERT_NONBINARYSIGNAL if analog alert handling DPCONFIG_NONE if no alert handling
alertTextsAlert texts are returned here
alertMatchesAlert limits are returned here
alertClassesAlert classes are returned here
alertPanelPanel to call from the alert screen
alertPanelParametersParameters to pass to the given alertPanel
alertHelpHelp text or path to help file
isDiscreteTRUE if the alert is discrete
impulseTRUE if alert is impulse alert else FALSE
discreteNegationfor each match values, TRUE if the match is negated (i.e. "!=").
stateBitsstate bits of the discrete alert
stateMatchstate bits of each value match
isActiveif alert is active
exceptionInfoDetails of any exceptions are returned here
See Also
fwAlertConfig_objectExtractAnalog(), fwAlertConfig_objectExtractDigital(), fwAlertConfig_objectExtractSummary()
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.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
alertConfigObjectobject from where to extract the parameters
alertTypeType 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
alertTextsAlert texts are returned here
alertClassesAlert classes are returned here
alertPanelPanel to call from the alert screen
alertPanelParametersParameters to pass to the given alertPanel
alertHelpHelp text or path to help file
isActiveif alert is active
exceptionInfoDetails of any exceptions are returned here
See Also
fwAlertConfig_objectExtractAnalog(), fwAlertConfig_objectExtractDiscrete(), fwAlertConfig_objectExtractSummary()
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.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
alertConfigObjectobject from where to extract the parameters
alertTypeType 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
alertTextsAlert texts are returned here
thresholdHow many single alarms must be triggered before they are filtered (i.e. not visible) by the summary alarm.
summaryDpeListList of dpes to include in summary alert
alertClassAlert classes are returned here
alertPanelPanel to call from the alert screen
alertPanelParametersParameters to pass to the given alertPanel
alertHelpHelp text or path to help file
isActiveif alert is active
exceptionInfoDetails of any exceptions are returned here
See Also
fwAlertConfig_objectExtractAnalog(), fwAlertConfig_objectExtractDiscrete(), fwAlertConfig_objectExtractDigital()
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:

  • limits parameters (index fwAlertConfig_ALERT_LIMIT), contains the parameters per range (classes, values...).
  • general parameters (index fwAlertConfig_ALERT_PARAM), contains the other parameters of the alarm (type, panel...).

How to fill the parameters object: use one of the functions "fwAlertConfig_objectCreate..." or fill it manually as in the examples given here:

  • example 1: create an analog alert object (3 ranges) using the utility functions and set it to the dpe
  • example 2: create a discrete alert object (3 ranges) using the utility functions and set it to the dpe
  • example 3: create and set an analog alarm with 3 ranges and the basic parameters
  • example 4: create and set a digital alarm with false = ok, true = alarm
  • example 5: create and set a digital alarm with false = alarm, true = ok
  • example 6: create a discrete alert object with 3 ranges and the basic parameters
  • example 7: create a summary alert object using utility function and set it to the dpe
  • example 8: create a summary alert object and set it to the dpe
Constraints
The alert parameter object must be previously filled.
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpethe datapoint element to configure
alertConfigObjectobject from where to extract the parameters
exceptionInfoDetails of any exceptions are returned here
See Also
fwAlertConfig_objectGet(), fwAlertConfig_objectSetMany(), fwAlertConfig_objectGetMany()
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()

  • example: get an analog alarm from a dpe
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpeName of data point element to read from
alertConfigObjectreturns the object containing the parameters and the limits objects of the alarm.
exceptionInfoDetails of any exceptions are returned here
See Also
fwAlertConfig_objectSet(), fwAlertConfig_objectSetMany(), fwAlertConfig_objectGetMany()
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()

  • example: get analog alerts objects from 2 dpes
Constraints
dpes in list must all belong to one system
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpesNames of data point elements to read from. It is passed as reference only for performance reasons. It is not modified.
alertConfigObjectsreturns the objects containing the parameters and the limits objects of the alarm.
exceptionInfoDetails of any exceptions are returned here
See Also
fwAlertConfig_objectSet(), fwAlertConfig_objectSetMany(), fwAlertConfig_objectGet()
fwAlertConfig_delete ( string  dpe,
dyn_string &  exceptionInfo,
string  removeDpeInSummary = "",
bool  storeInParamHistory = TRUE 
)

Deletes the alert config for the given data point element

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpedata point element
exceptionInfodetails of any errors are returned here
removeDpeInSummaryOPTIONAL 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
storeInParamHistoryOPTIONAL 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.

Constraints
Only works on dpes with alert handling already configured
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpeData point element to act on
exceptionInfoDetails of any exceptions are returned here
checkIfExistsOptional 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)
storeInParamHistoryOPTIONAL 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.

Constraints
Only works on dpes with alert handling already configured
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpesthe list of data point elements to act on
exceptionInfoDetails of any exceptions are returned here
checkIfExistsOptional 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)
storeInParamHistoryOPTIONAL 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.

Constraints
Only works on dpes with alert handling already configured
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpeData point element to act on
exceptionInfoDetails of any exceptions are returned here
checkIfExistsOptional 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)
storeInParamHistoryOptional 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.

Constraints
Only works on dpes with alert handling already configured
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpesThe list of data point elements to act on
exceptionInfoDetails of any exceptions are returned here
checkIfExistsOptional 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)
storeInParamHistoryOptional 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.

Constraints
Only works on dpes with alert handling already configured
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpeData point element to act on
exceptionInfoDetails of any exceptions are returned here
acknowledgeOptional parameter (Default value - TRUE) TRUE for acknowledge alert when deactivating FALSE to leave alert unacknowledge when deactivated
checkIfExistsOptional 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)
storeInParamHistoryOptional 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.

Constraints
Only works on dpes with alert handling already configured
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpesList of data point elements to act on
exceptionInfoDetails of any exceptions are returned here
acknowledgeOptional parameter (Default value - TRUE) TRUE for acknowledge alert when deactivating FALSE to leave alert unacknowledge when deactivated
checkIfExistsOptional 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)
storeInParamHistoryOptional 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.

  • example 1: create 3-ranges alarms for 2 datapoint elements
  • example 2: create a 3-ranges alarm and set it to 4 datapoint elements. Note: the dpes must all be of the same type.
  • example 3: create 4 alarms and set them to 4 datapoint elements of type bit32.
    Constraints
    The alert parameter object must be previously filled.
    Usage
    Public
    PVSS managers
    VISION, CTRL
    Parameters
    dpeslist of datapoint elements to configure. It is passed as reference only for performance reasons. It is not modified.
    alertConfigObjectslist 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.
    exceptionInfoDetails of any exceptions are returned here
    See Also
    fwAlertConfig_objectSet(), fwAlertConfig_objectGet(), fwAlertConfig_objectGetMany()
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

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpeslist of data point elements
exceptionInfodetails of any errors are returned here
removeDpeInSummaryOPTIONAL 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
storeInParamHistoryOPTIONAL 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

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpeslist of data point elements
exceptionInfodetails of any errors are returned here
removeDpeInSummaryOPTIONAL 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
storeInParamHistoryOPTIONAL PARAMETER - default value = TRUE You can specify if the change should be stored in the Paramterisation History of PVSS

Variable Documentation

const int fwAlertConfig_ALERT_LIMIT_TEXT = 1

Text of the alarm range.

Description
Limit configuration item. Text of the alarm range, shown when the alert is flagged as CAME.
Parameter Type
string
Usage
Compulsory. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_LIMIT_VALUE = 2

Value of the alarm range.

Description
Limit configuration item. Value of the alarm range.
Parameter Type
float
Usage
Compulsory for analog alarms. For analog alarms only. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_LIMIT_VALUE_INCLUDED = 3

Specify if the value of the alarm range must be included.

Description
Limit configuration item. Specify if the value of the alarm range must be included (<=) or not (<). True means included.
Parameter Type
bool
Usage
Optional. For analog alarms. Default value is false. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_LIMIT_CLASS = 4

Class of the alarm range.

Description
Limit configuration item. Class of the alarm range. The ok range must be an empty string "". For more info, refer to PVSS help.
Parameter Type
string
Usage
Compulsory. For all types of alarms. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_LIMIT_VALUE_MATCH = 5

Value to match for the alarm range.

Description
Limit configuration item. Value to match for the alarm range. Can be one value (i.e. "3"), a set of values (i.e. "3,5,6"), or a range (i.e. "3-7")
Parameter Type
string
Usage
Compulsory for discrete alarms. For discrete alarms only. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_LIMIT_NEGATION = 8

If true, the value to match for the alarm range is negated.

Description
Limit configuration item. If true, the value to match for the alarm range is negated (!=). If false, the value must match (=).
Parameter Type
bool
Usage
Optional. For discrete alarms only. Default value is false. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_LIMIT_STATE_BITS = 9

State bits values that must match.

Description
Limit configuration item. State bits values that must match. For more detail, see PVSS help.
Parameter Type
string
Usage
Optional. For discrete alarms only. Default value is "". Possible values: 1, 0, X (ex: "11000000000000000000000001010101XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"). 0 = must be 0; 1 = must be 1; X = can be 0 or 1. Note: all the 64 bits must be given. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_LIMIT_LIMITS_STATE_BITS = 10

State bits values that must match for a specific range.

Description
Limit configuration item. State bits values that must match for a specific range. For more detail, see PVSS help.
Parameter Type
string
Usage
Optional. For discrete alarms only. Default value is "". Possible values: 1, 0 (ex: "1100000000000000000000000101010100000000000000000000000000000000"). 0 = must be 0; 1 = must be 1. Note: all the 64 bits must be given. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_LIMIT_TEXT_WENT = 11

Text of the alarm range.

Description
Limit configuration item. Text of the alarm range, shown when the alert is flagged as WENT.
Parameter Type
string
Usage
Optional. For all types of alarms. Default value is "". See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_LIMIT_HYSTERESIS_UP = 12

Upper hysteresis limit.

Description
Hysteresis higher limit configuration item.
Parameter Type
string
Usage
Optional. For analog alarms. Must be a positive value. Default value is 0.0 and means no hysteresis. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_LIMIT_HYSTERESIS_LOW = 13

Lower hysteresis limit.

Description
Hysteresis lower limit configuration item.
Parameter Type
string
Usage
Optional. For analog alarms. Must be a negative value. Default value is 0.0 and means no hysteresis. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_PARAM_TYPE = 1

Type of alarm.

Description
General parameter item. Type of alarm. Possible values:
  • DPCONFIG_NONE
  • DPCONFIG_ALERT_BINARYSIGNAL
  • DPCONFIG_ALERT_NONBINARYSIGNAL
  • DPCONFIG_SUM_ALERT
For more info, refer to PVSS help.
Parameter Type
int
Usage
Compulsory. For all types of alarms. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_PARAM_SUM_DPE_LIST = 2

List of DPEs in summary alerts.

Description
General parameter item. For summary alert, list of DPEs to be checked for single alarms. If you want to specify a DP pattern, then this should entered as the first item in this list.
Parameter Type
dyn_string
Usage
Optional. For summary alarms only. Default value is empty. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_PARAM_ADD_DPE_TO_SUMMARY = 3

Add the new alert in a summary alert.

Description
General parameter item. 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 do not exist, it WILL NOT be created.
Parameter Type
string
Usage
Optional. For alarms of type analog, discrete, binary. Default value is "". See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_PARAM_SUM_THRESHOLD = 4

Threshold filter parameter for the sum alerts.

Description
General parameter item. Threshold filter parameter for the sum alerts. It can be used to specify after how many single alarms only the sum alert should be shown. If i.e. the threshold 5 is set and there are five single alarms, only the sum alert is shown in the alert screen.
Parameter Type
int
Usage
Optional. For summary alarms only. Default value is 0. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_PARAM_PANEL = 5

Displays the file path of the panel.

Description
General parameter item. Displays the file path of the panel to be displayed when an alert occurs. The path is specified relative to the panel directory.
Parameter Type
string
Usage
Optional. For all alarms. Default value is "". See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_PARAM_IMPULSE = 9

set to true if impulse alarm

Description
General parameter item. true = impulse alarm. For more info, refer to PVSS help.
Parameter Type
bool
Usage
Optional. For discrete alarms only. Default value is false. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_PARAM_RANGES = 13

Number of alarm ranges.

Description
General parameter item. Number of alarm ranges.
Parameter Type
int
Usage
Compulsory. For analog and discrete alarms. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_PARAM_ACTIVE = 14

alarm active

Description
General parameter item. If true, the alarm is active.
Parameter Type
bool
Usage
Optional. READ ONLY. For all types of alarms.
const int fwAlertConfig_ALERT_PARAM = 1
Description
General configuration object. The configuration object contains 2 sub-elements:
  • ALERT_PARAM, containing elements for general configuration (type... - all fwAlertConfig_ALERT_PARAM_*).
  • ALERT_LIMIT, containing elements concerning limits (text, values, class... - all fwAlertConfig_ALERT_LIMIT_*).
Parameter Type
dyn_dyn_anytype
Usage
Compulsory. For all types of alarms. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_LIMIT = 2

Limits configuration object.

Description
Limits configuration object. The configuration object contains 2 sub-elements:
  • ALERT_PARAM, containing elements for general configuration (type... - all fwAlertConfig_ALERT_PARAM_*).
  • ALERT_LIMIT, containing elements concerning limits (text, values, class... - all fwAlertConfig_ALERT_LIMIT_*).
Parameter Type
dyn_dyn_anytype
Usage
Compulsory. For all types of alarms. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_PARAM_PANEL_PARAMETERS = 6

$-parameters to be passed when calling the panel

Description
General parameter item. Here you can enter $-parameters to be passed when calling the panel specified on fwAlertConfig_ALERT_PARAM_PANEL.
Parameter Type
dyn_string
Usage
Optional. For all alarms. Default value is empty. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_PARAM_HELP = 7

Information concerning the alert.

Description
General parameter item. Enter a text to assist the user with information concerning the alert. This text can either be interpreted as "pure" text in the control script and displayed in the panel or also used as a file name (e.g. of an HTML file).
Parameter Type
string
Usage
Optional. For all alarms. Default value is "". See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_PARAM_DISCRETE = 8

Set to true if discrete alarm.

Description
General parameter item. Set to true if discrete alarm. To false if else.
Parameter Type
bool
Usage
Optional. For discrete alarms only. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_PARAM_MODIFY_ONLY = 10

Set to true to modify alert without setting "type" attributes.

Description
General parameter item. 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.
Parameter Type
bool (needs to be used inside the dyn_ context, eg. alarmParams[fwAlertConfig_ALERT_PARAM_MODIFY_ONLY][1] = false )
Usage
Optional. For all types of alarms. Default value is false. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_PARAM_FALLBACK_TO_SET = 11

Used in combination with modifyOnly.

Description
General parameter item. Used in combination with modifyOnly. Default value: false.
  • 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.
Parameter Type
bool
Usage
Optional. For all types of alarms. Default value is false. See use example on fwAlertConfig_objectSet().
const int fwAlertConfig_ALERT_PARAM_STORE_IN_HISTORY = 12

if the change should be stored in the Paramterisation History

Description
General parameter item. You can specify if the change should be stored in the Paramterisation History of PVSS.
Parameter Type
bool
Usage
Optional. For all types of alarms. Default value is true. See use example on fwAlertConfig_objectSet().