fwAlarmHandling
8.4.0
|
Functions | |
fwAlarmHandlingScreen_readFilter (dyn_dyn_anytype &aesFilter, dyn_string &exceptionInfo) | |
fwAlarmHandlingScreen_showFilter (dyn_dyn_anytype aesFilter, dyn_string &exceptionInfo) | |
fwAlarmHandlingScreen_loadFilter (string fwAesConfigDp, dyn_dyn_anytype &aesFilter, dyn_string &exceptionInfo) | |
fwAlarmHandlingScreen_saveFilter (string fwAesConfigDp, dyn_dyn_anytype aesFilter, dyn_string &exceptionInfo) | |
fwAlarmHandlingScreen_applyFilter (string pvssAesPropertiesDp, dyn_dyn_anytype aesFilter, dyn_string &exceptionInfo, bool updateAes=TRUE) | |
fwAlarmHandlingScreen_evaluateDpFilter (dyn_dyn_anytype aesFilter, dyn_string &evaluatedFilter, dyn_string &exceptionInfo) | |
_fwAlarmHandlingScreen_removeAsteriskFilters (dyn_string &filter, dyn_string &exceptionInfo) | |
fwAlarmHandlingScreen_evaluateSeverityFilter (dyn_dyn_anytype aesFilter, string &evaluatedFilter, dyn_string &exceptionInfo, int localOrGlobal=0) | |
_fwAlarmHandlingScreen_getDefaultFilter (dyn_dyn_anytype &aesFilter, dyn_string &exceptionInfo) | |
_fwAlarmHandlingScreen_getDefaultMode (dyn_anytype &aesMode, dyn_string &exceptionInfo) | |
fwAlarmHandlingScreen_readMode (dyn_anytype &aesMode, dyn_string &exceptionInfo) | |
fwAlarmHandlingScreen_showMode (dyn_anytype &aesMode, dyn_string &exceptionInfo) | |
fwAlarmHandlingScreen_applyMode (string pvssAesPropertiesDp, dyn_anytype aesMode, dyn_string &exceptionInfo, bool updateAes=TRUE) | |
_fwAlarmHandlingScreen_convertFilterToDollar (dyn_dyn_anytype aesFilter, string &dollarValue, dyn_string &exceptionInfo) | |
_fwAlarmHandlingScreen_convertDollarToFilter (string dollarValue, dyn_dyn_anytype &aesFilter, dyn_string &exceptionInfo) | |
_fwAlarmHandlingScreen_showHideColumn (string pvssAesPropertiesDp, string columnName, bool visible, dyn_string &exceptionInfo, bool updateAes=FALSE) | |
_fwAlarmHandlingScreen_showHideColumns (string pvssAesPropertiesDp, dyn_string columnName, dyn_bool visible, dyn_string &exceptionInfo, bool updateAes=FALSE) | |
fwAlarmHandlingScreen_getColumnWidths (dyn_string &columnsName, dyn_bool &columnsVisible, dyn_int &columnsWidth, dyn_string &exceptionInfo) | |
fwAlarmHandlingScreen_setColumnWidths (dyn_string columnsName, dyn_bool columnsVisible, dyn_int columnsWidth, dyn_string &exceptionInfo) | |
fwAlarmHandlingScreen_setDescriptionColumnBehaviour (int columnBehaviour, dyn_string &exceptionInfo) | |
fwAlarmHandlingScreen_setOneRowPerAlarm (bool oneRowPerAlarm, dyn_string &exceptionInfo) | |
fwAlarmHandlingScreen_getOneRowPerAlarm (bool &oneRowPerAlarm, dyn_string &exceptionInfo) | |
fwAlarmHandlingScreen_getDescriptionColumnBehaviour (int &columnBehaviour, dyn_string &exceptionInfo) | |
This library contains functions for the internal workings of the JCOP Alarm Screen.
13/08/2012 Marco
{FWAH-260}: Alarm screen with Groups: "New" alarms on the groups are not updated. Added new function _fwAlarmHandlingScreen_addHelpOpenComment() that marks as comment the time when the user opens the alarm help by right-clicking on the corresponding alarm line
21/032011 Marco
{78859}: filters for dpNames can now accept multiple items.
13/04/2010 Marco
{42996}: commented out the convertion from * to full list of dist system names.
07/04/2010 Marco
{55217}: commented out the use of function _fwAlarmHandling_convertSeverityRangeToList().
2010/03/26 Marco
fwAlarmHandlingScreen_readFilter | ( | dyn_dyn_anytype & | aesFilter, |
dyn_string & | exceptionInfo | ||
) |
Reads the filter options from the alarm screen filter graphical objects
aesFilter | The filter object is returned here with the filter as defined in the graphical objects Use the fwAlarmHandlingScreen_CONFIG_OBJECT_FILTER_XXX constants to interpret the object |
exceptionInfo | Details of any exceptions are returned here |
fwAlarmHandlingScreen_showFilter | ( | dyn_dyn_anytype | aesFilter, |
dyn_string & | exceptionInfo | ||
) |
Shows the given filter options in the alarm screen filter graphical objects
aesFilter | The filter object with the filter data to display in the graphical objects Use the fwAlarmHandlingScreen_CONFIG_OBJECT_FILTER_XXX constants to interpret the object |
exceptionInfo | Details of any exceptions are returned here |
fwAlarmHandlingScreen_loadFilter | ( | string | fwAesConfigDp, |
dyn_dyn_anytype & | aesFilter, | ||
dyn_string & | exceptionInfo | ||
) |
Reads the filter options from the given filter configuration data point
fwAesConfigDp | The filter configuration data point to read from |
aesFilter | The filter object with the filter data is returned here Use the fwAlarmHandlingScreen_CONFIG_OBJECT_FILTER_XXX constants to interpret the object |
exceptionInfo | Details of any exceptions are returned here |
fwAlarmHandlingScreen_saveFilter | ( | string | fwAesConfigDp, |
dyn_dyn_anytype | aesFilter, | ||
dyn_string & | exceptionInfo | ||
) |
Saves the filter options to the given filter configuration data point
fwAesConfigDp | The filter configuration data point to write to |
aesFilter | The filter object with the filter data is passed here Use the fwAlarmHandlingScreen_CONFIG_OBJECT_FILTER_XXX constants to interpret the object |
exceptionInfo | Details of any exceptions are returned here |
fwAlarmHandlingScreen_applyFilter | ( | string | pvssAesPropertiesDp, |
dyn_dyn_anytype | aesFilter, | ||
dyn_string & | exceptionInfo, | ||
bool | updateAes = TRUE |
||
) |
Applies the given filter options to the given PVSS runtime properties dp. The given PVSS runtime dp should be the
one that corresponds to the alarm screen display you want to update. This can be obtained using "aes_getPropDpName()" and the dp should be of type "_AESProperties".
pvssAesPropertiesDp | The PVSS runtime properties dp for the given alarm screen |
aesFilter | The filter object with the filter data is passed here Use the fwAlarmHandlingScreen_CONFIG_OBJECT_FILTER_XXX constants to interpret the object |
exceptionInfo | Details of any exceptions are returned here |
updateAes | OPTIONAL PARAMETER - default value TRUE If TRUE, perform aes_doRestart after setting the new filter If FALSE, do not perform aes_doRestart |
fwAlarmHandlingScreen_evaluateDpFilter | ( | dyn_dyn_anytype | aesFilter, |
dyn_string & | evaluatedFilter, | ||
dyn_string & | exceptionInfo | ||
) |
Calculates from the given filter options, the most compact filter to pass to the PVSS runtime properties dp.
For simple filters, this could involve just the DP name filter - e.g. "CAEN/*". However, for more complex filters, it will usually be a list of DPs that match all the filter criteria.
aesFilter | The filter object with the filter data is passed here Use the fwAlarmHandlingScreen_CONFIG_OBJECT_FILTER_XXX constants to interpret the object |
evaluatedFilter | The most compact form to express the result of the filter is returned here |
exceptionInfo | Details of any exceptions are returned here |
_fwAlarmHandlingScreen_removeAsteriskFilters | ( | dyn_string & | filter, |
dyn_string & | exceptionInfo | ||
) |
Sets any "*" filters to "". The PVSS alarm screen requires "" instead of "*" to mean ALL for some filtering criteria.
If any other criteria are given as well as a "*", then they are ignored as everything will already meet the "*" criteria.
filter | Input/Output - The filter to reduce and make ready for the PVSS alarm screen |
exceptionInfo | Details of any exceptions are returned here |
fwAlarmHandlingScreen_evaluateSeverityFilter | ( | dyn_dyn_anytype | aesFilter, |
string & | evaluatedFilter, | ||
dyn_string & | exceptionInfo, | ||
int | localOrGlobal = 0 |
||
) |
Calculates from the given filter options, the priority filter which needs to be passed to the PVSS runtime properties dp.
This function basically converts from FW severity (W,E,F) to PVSS priorities (40-59,60-79,80-255)
aesFilter | The filter object with the filter data is passed here Use the fwAlarmHandlingScreen_CONFIG_OBJECT_FILTER_XXX constants to interpret the object |
evaluatedFilter | The priority filter for the PVSS alarm screen is returned here |
exceptionInfo | Details of any exceptions are returned here |
localOrGlobal | Optional parameter - default value 0 If 0, show all alerts in ranges (e.g. 40-59 for WARNING) If 1, show upper part of ranges - assumed to be global alerts (e.g. 50-59 for WARNING) If 2, show lower part of ranges - assumed to be local alerts (e.g. 40-49 for WARNING) |
_fwAlarmHandlingScreen_getDefaultFilter | ( | dyn_dyn_anytype & | aesFilter, |
dyn_string & | exceptionInfo | ||
) |
Gets a filter object configured with the default filter criteria (basically ALL)
aesFilter | The filter object is returned here with the default filter criteria Use the fwAlarmHandlingScreen_CONFIG_OBJECT_FILTER_XXX constants to interpret the object |
exceptionInfo | Details of any exceptions are returned here |
_fwAlarmHandlingScreen_getDefaultMode | ( | dyn_anytype & | aesMode, |
dyn_string & | exceptionInfo | ||
) |
Gets a mode object configured with the default mode options for the alarm screen
aesMode | The mode object is returned here with the default filter criteria Use the fwAlarmHandlingScreen_CONFIG_OBJECT_MODE_XXX constants to interpret the object |
exceptionInfo | Details of any exceptions are returned here |
fwAlarmHandlingScreen_readMode | ( | dyn_anytype & | aesMode, |
dyn_string & | exceptionInfo | ||
) |
Reads the mode options from the alarm screen mode graphical objects
aesMode | The mode object is returned here with the mode criteria as defined in the graphical objects Use the fwAlarmHandlingScreen_CONFIG_OBJECT_MODE_XXX constants to interpret the object |
exceptionInfo | Details of any exceptions are returned here |
fwAlarmHandlingScreen_showMode | ( | dyn_anytype & | aesMode, |
dyn_string & | exceptionInfo | ||
) |
Shows the given mode options in the alarm screen mode graphical objects
aesMode | The mode object with the mode data to display in the graphical objects Use the fwAlarmHandlingScreen_CONFIG_OBJECT_MODE_XXX constants to interpret the object |
exceptionInfo | Details of any exceptions are returned here |
fwAlarmHandlingScreen_applyMode | ( | string | pvssAesPropertiesDp, |
dyn_anytype | aesMode, | ||
dyn_string & | exceptionInfo, | ||
bool | updateAes = TRUE |
||
) |
Applies the given mode options to the given PVSS runtime properties dp. The given PVSS runtime dp should be the
one that corresponds to the alarm screen display you want to update. This can be obtained using "aes_getPropDpName()" and the dp should be of type "_AESProperties".
pvssAesPropertiesDp | The PVSS runtime properties dp for the given alarm screen |
aesMode | The mode object with the mode data is passed here Use the fwAlarmHandlingScreen_CONFIG_OBJECT_MODE_XXX constants to interpret the object |
exceptionInfo | Details of any exceptions are returned here |
updateAes | OPTIONAL PARAMETER - default value TRUE If TRUE, perform aes_doRestart after setting the new mode If FALSE, do not perform aes_doRestart |
_fwAlarmHandlingScreen_convertFilterToDollar | ( | dyn_dyn_anytype | aesFilter, |
string & | dollarValue, | ||
dyn_string & | exceptionInfo | ||
) |
This function converts a filter configuration object into a string value that can be passed as a dollar parameter.
To decode the string back into a filter ibject, use _fwAlarmHandlingScreen_convertDollarToFilter().
aesFilter | The filter object with the filter data is passed here Use the fwAlarmHandlingScreen_CONFIG_OBJECT_FILTER_XXX constants to interpret the object |
dollarValue | The string value to be passed as a dollar parameter is returned here |
exceptionInfo | Details of any exceptions are returned here |
_fwAlarmHandlingScreen_convertDollarToFilter | ( | string | dollarValue, |
dyn_dyn_anytype & | aesFilter, | ||
dyn_string & | exceptionInfo | ||
) |
This function converts a string representation of a filter into a filter object.
To decode the string back into a filter object, use _fwAlarmHandlingScreen_convertFilterToDollar().
dollarValue | The string equivalent of the filter object is passed here |
aesFilter | The filter object with the filter data is returned here Use the fwAlarmHandlingScreen_CONFIG_OBJECT_FILTER_XXX constants to interpret the object |
exceptionInfo | Details of any exceptions are returned here |
_fwAlarmHandlingScreen_showHideColumn | ( | string | pvssAesPropertiesDp, |
string | columnName, | ||
bool | visible, | ||
dyn_string & | exceptionInfo, | ||
bool | updateAes = FALSE |
||
) |
Changes the visibility of the named column in the Alarm Screen. The given PVSS runtime dp should be the
one that corresponds to the alarm screen display you want to update. This can be obtained using "aes_getPropDpName()" and the dp should be of type "_AESProperties".
pvssAesPropertiesDp | The PVSS runtime properties dp for the given alarm screen |
columnName | The name of the column to be hidden/shown |
visible | TRUE to show column, FALSE to hide columns |
exceptionInfo | Details of any exceptions are returned here |
updateAes | OPTIONAL PARAMETER - default value TRUE If TRUE, perform aes_doRestart after setting the new filter If FALSE, do not perform aes_doRestart |
_fwAlarmHandlingScreen_showHideColumns | ( | string | pvssAesPropertiesDp, |
dyn_string | columnName, | ||
dyn_bool | visible, | ||
dyn_string & | exceptionInfo, | ||
bool | updateAes = FALSE |
||
) |
Changes the visibility of the named columns in the Alarm Screen. The given PVSS runtime dp should be the
one that corresponds to the alarm screen display you want to update. This can be obtained using "aes_getPropDpName()" and the dp should be of type "_AESProperties".
pvssAesPropertiesDp | The PVSS runtime properties dp for the given alarm screen |
columnName | The array of names of the columns to be hidden/shown |
visible | The array of values for the columns: TRUE to show column, FALSE to hide column |
exceptionInfo | Details of any exceptions are returned here |
updateAes | OPTIONAL PARAMETER - default value TRUE If TRUE, perform aes_doRestart after setting the new filter If FALSE, do not perform aes_doRestart |
fwAlarmHandlingScreen_getColumnWidths | ( | dyn_string & | columnsName, |
dyn_bool & | columnsVisible, | ||
dyn_int & | columnsWidth, | ||
dyn_string & | exceptionInfo | ||
) |
Reads the column names, visibility and widths of the alarm screen table in the current panel.
columnsName | The list of names of the columns that are in the current alarm screen table. |
columnsVisible | The list of BOOLEANs representing the current visible state of each column. TRUE to show column, FALSE to hide columns |
columnsWidth | The list of the current widths of each column. |
exceptionInfo | Details of any exceptions are returned here |
fwAlarmHandlingScreen_setColumnWidths | ( | dyn_string | columnsName, |
dyn_bool | columnsVisible, | ||
dyn_int | columnsWidth, | ||
dyn_string & | exceptionInfo | ||
) |
Sets the column visibility and widths of the given columns in the alarm screen table in the current panel.
columnsName | The list of names of the columns to configure. |
columnsVisible | The list of BOOLEANs representing the desired visible state of each column. TRUE to show column, FALSE to hide columns |
columnsWidth | The list of desired widths of each column. |
exceptionInfo | Details of any exceptions are returned here |
fwAlarmHandlingScreen_setDescriptionColumnBehaviour | ( | int | columnBehaviour, |
dyn_string & | exceptionInfo | ||
) |
Sets the behaviour of the description column. If no description exists on the alarm dpe, or the root dpe of the dp, then either an
empty string or the dpe name can be shown.
columnBehaviour | any of the constants fwAlarmHandling_BEHAVIOUR_... |
exceptionInfo | Details of any exceptions are returned here |
fwAlarmHandlingScreen_setOneRowPerAlarm | ( | bool | oneRowPerAlarm, |
dyn_string & | exceptionInfo | ||
) |
Sets one line per alarm or one line per event (i.e. one line per CAME, one line per WENT).
oneRowPerAlarm | input, TRUE - one line per alarm. CAM or WENT is shown, with the last timestamp. FALSE - one line for CAME, one line for WENT. |
exceptionInfo | output, Details of any exceptions are returned here |
fwAlarmHandlingScreen_getOneRowPerAlarm | ( | bool & | oneRowPerAlarm, |
dyn_string & | exceptionInfo | ||
) |
Gets one line per alarm or one line per event (i.e. one line per CAME, one line per WENT).
oneRowPerAlarm | output, TRUE - one line per alarm. CAM or WENT is shown, with the last timestamp. FALSE - one line for CAME, one line for WENT. |
exceptionInfo | output, Details of any exceptions are returned here |
fwAlarmHandlingScreen_getDescriptionColumnBehaviour | ( | int & | columnBehaviour, |
dyn_string & | exceptionInfo | ||
) |
Gets the current behaviour of the description column. If no description exists on the alarm dpe, or the root dpe of the dp, then either an
empty string or the dpe name can be shown.
columnBehaviour | any of the constants fwAlarmHandling_BEHAVIOUR_... |
exceptionInfo | Details of any exceptions are returned here |