fwAlarmHandling  8.4.0
fwAlarmScreen.ctl File Reference

Functions

void fwAlarmScreen_initUIElements ()
 
void fwAlarmScreen_initAES (string sLoadFilter="")
 
bool fwAlarmScreen_checkAESConfig ()
 
void fwAlarmScreen_makeAESConfig (dyn_string &dsExceptions)
 
bool fwAlarmScreen_isAdmin ()
 
void fwAlarmScreen_applyFilter (string pvssAesPropertiesDp, dyn_dyn_anytype ddaAesFilter, dyn_string &dsExceptions, bool bUpdateAes=true)
 
 fwAlarmScreen_readFilter (dyn_dyn_anytype &ddaAesFilter, dyn_string &dsExceptions)
 
 fwAlarmScreen_showFilter (dyn_dyn_anytype ddaAesFilter, dyn_string &dsExceptions)
 
void fwAlarmScreen_saveFilter (string sFwAesConfigDp, dyn_dyn_anytype aesFilter, dyn_string &exceptionInfo)
 
 fwAlarmScreen_loadFilter (string sFwAesConfigDp, dyn_dyn_anytype &ddaAesFilter, dyn_string &dsExceptions)
 
 _fwAlarmScreen_getDefaultFilter (dyn_dyn_anytype &ddaAesFilter, dyn_string &dsExceptions)
 
void fwAlarmScreen_getQuickFilterList (dyn_string &dsQuickFilter, dyn_string &dsExceptions)
 
void fwAlarmScreen_reloadQuickFilterList ()
 
void fwAlarmScreen_saveQuickFilterOptions (string fwAesConfigDp, bool isQuickFilter, string accessRight, dyn_string &exceptionInfo)
 
void fwAlarmScreen_loadQuickFilterOptions (string fwAesConfigDp, bool &isQuickFilter, string &accessRight, dyn_string &exceptionInfo)
 
void fwAlarmScreen_getDefaultFilterName (string &defaultFilter, dyn_string &exceptionInfo)
 
 fwAlarmScreen_readMode (dyn_anytype &daAesMode, dyn_string &dsExceptions)
 
 fwAlarmScreen_showMode (dyn_anytype &daAesMode, dyn_string &dsExceptions)
 
 fwAlarmScreen_applyMode (string sPropertiesDp, dyn_anytype aesMode, dyn_string &dsExceptions, bool updateAes=true)
 
 _fwAlarmScreen_getDefaultMode (dyn_anytype &daAesMode, dyn_string &dsExceptions)
 
void fwAlarmScreen_initFields (dyn_anytype &daAesMode, dyn_dyn_anytype &ddaAesFilter, dyn_string &dsExceptions)
 
void fwAlarmScreen_getDpsMatchingCriteria (dyn_string dsSystemNameFilters, dyn_string dpNameFilters, dyn_string dpAliasFilters, dyn_string dpTypeFilters, dyn_string &matchingDps, dyn_string &dsExceptions)
 
void fwAlarmScreen_evaluateDpFilter (dyn_dyn_anytype ddaAesFilter, dyn_string &dsEvaluatedFilter, dyn_string &dsExceptions)
 
void fwAlarmScreen_evaluateSeverityFilter (dyn_dyn_anytype ddaAesFilter, string &sEvaluatedFilter, dyn_string &dsExceptions, int iLocalOrGlobal=0)
 
void fwAlarmScreen_getColumnWidths (dyn_string &dsColumnName, dyn_bool &dbColumnVisible, dyn_int &diColumnWidth, dyn_string &dsExceptions)
 
void fwAlarmScreen_returnToDefaultView ()
 
void fwAlarmScreen_getAccessControlOptions (dyn_string &dsAccessRights, dyn_string &dsExceptions)
 
void fwAlarmScreen_setAccessControlOptions (dyn_string dsAccessRights, dyn_string &exceptionInfo)
 
void fwAlarmScreen_limitButtonAccess ()
 
void fwAlarmScreen_getDescriptionColumnBehaviour (int &iColumnBehaviour, dyn_string &dsExceptions)
 
void fwAlarmScreen_getRowColourBehaviour (bool &bColorWholeRow, dyn_string &dsExceptions)
 
void fwAlarmScreen_setDescriptionColumnBehaviour (int iColumnBehaviour, dyn_string &dsExceptions)
 
void fwAlarmScreen_setRowColourBehaviour (bool bColorWholeRow, dyn_string &dsExceptions)
 
void fwAlarmScreen_showHideColumn (string sPvssAesPropertiesDp, string sColumnName, bool bVisible, dyn_string &dsExceptions, bool bUpdateAes=FALSE)
 
void fwAlarmScreen_getShowHideColumn (string sPvssAesPropertiesDp, string sColumnName, bool &bVisible, dyn_string &dsExceptions)
 
void fwAlarmScreen_setAesColumnVisibility (const string &sDpe)
 
void fwAlarmScreen_showHideColumns (string sPvssAesPropertiesDp, dyn_string dsColumnName, dyn_bool dbVisible, dyn_string &dsExceptions, bool bUpdateAes=FALSE)
 
void fwAlarmScreen_setDefaultFilterName (string sDefaultFilter, dyn_string &dsExceptions)
 
private string _fwAlarmScreen_getAlarmTableName ()
 
dyn_string fwAlarmScreen_getRightClickMenuOptions (int iRow, string sColumn)
 
void fwAlarmScreen_treatRightClickAnswer (int iAnswer, int iRow, string sColumn)
 
void _fwAlarmScreen_showTrend (mapping mRowHeaderMapping, int iRow, string sPropertiesDp, int iTabType, string sTableName, dyn_string &dsExceptions)
 
void _fwAlarmScreen_showFsmPanel (mapping mRowHeaderMapping, int iRow, string sPropertiesDp, int iTabType, string sTableName, dyn_string &dsExceptions)
 
void _fwAlarmScreen_showDetails (mapping mRowHeaderMapping, int iRow, string sPropertiesDp, int iTabType, string sTableName, dyn_string &dsExceptions)
 
void _fwAlarmScreen_showCommentPanel (mapping mRowHeaderMapping, int iRow, string sPropertiesDp, int iTabType, string sTableName, dyn_string &dsExceptions)
 
void _fwAlarmScreen_showHelp (mapping mRowHeaderMapping, int iRow, string sPropertiesDp, int iTabType, string sTableName, dyn_string &dsExceptions)
 
void fwAlarmScreen_getRightClickConfig (dyn_string &menuItems, dyn_string &menuFunctions, dyn_string &menuAlertTypes, dyn_string &exceptionInfo)
 
void _fwAlarmScreen_countDownToShowStopped ()
 
void fwAlarmScreen_idleCheck ()
 
void fwAlarmScreen_updateOnlineValues ()
 
void fwAlarmScreen_userChanged (const string sUser)
 
void fwAlarmScreen_busyCallBack (string sDpe, const int iBusyState)
 
void fwAlarmScreen_runningStateCallback (string sDpe, unsigned uRunMode)
 
void fwAlarmScreen_eventHandler (const string sDp, const int iEvent)
 
void fwAlarmScreen_copyTableStyle (const string sTableSource, const string sTableDest)
 
void fwAlarmScreen_resizePanel ()
 
void fwAlarmScreen_saveConfig ()
 
dyn_string fwAlarmScreen_getConfigPanels ()
 
dyn_string fwAlarmScreen_getShowableColumns ()
 
void fwAlarmScreen_reloadConfig ()
 
void fwAlarmScreen_closePanel ()
 
 fwAlarmScreen_openScreenWithGroup (bool bAsNewModule, bool bStayOnTopOrModal, string sModuleName, string sPanelName, string sGroupName, dyn_string &exceptionInfo, unsigned x=0, unsigned y=0)
 
 fwAlarmScreen_openScreen (bool bAsNewModule, bool bStayOnTopOrModal, string sModuleName, string sPanelName, dyn_string dollarParams, dyn_string &exceptionInfo, unsigned x=0, unsigned y=0)
 
void fwAlarmScreen_alarmFilter_init ()
 

Detailed Description

Description:
This library contains all the functions used by the JCOP alarm screen. Most of the code comes from the former fwAlarmHandling libraries but has been rearranged and cleaned.

Throughout the whole library, a dyn_dyn_anytype is used to describe a filter. It's indexes can be accessed via the variables xxx_CONFIG_OBJECT_FILTER_xxx.

Creation Date
08/02/2013
Modification History
24/05/2017 Adrian Crestar Santome
  • New function 'fwAlarmScreen_setAesColumnsVisibility" that is called when the user modifies the column visibility and saves the configuration. It will check which columns are part of the 'Showable Columns' in the table (see the function 'fwAlarmScreen_getShowableColumns') and modify the Properties DP accordingly.
  • The functions 'fwAlarmScreen_showHideColumn' and 'fwAlarmScreen_showHideColumns' have been modified to update the Properties DP cache. Otherwise, the columns will be hidden again until the Alarm Screen is re-opened and the cache is updated.
Author
Cyril Caillaba (EN-ICE-SCD)
Description:
This library contains all the functions used by the groups in the JCOP alarm panel. Lot of this code has been adapted from the former JCOP panel dedicated to groups only. It has been fully included to the normal JCOP alarm panel.
Creation Date:
08/02/2013
Modification history:
Author
Cyril Caillaba (EN-ICE-SCD)

Function Documentation

void fwAlarmScreen_initUIElements ( )
Description:
Init the widgets inside the panel (show, fill, ...).
Usage:
Internal.
void fwAlarmScreen_initAES ( string  sLoadFilter = "")
Description:
Initialize the AES. Load settings and start alarm monitoring.
Usage:
Internal.
Parameters
[in]sLoadFilterstring, The filter to load on initialization.
bool fwAlarmScreen_checkAESConfig ( )
Description:
Check if the AES is configured for JCOP.
Usage:
Public.
Returns
True if the AES is configured for JCOP, false otherwise.
void fwAlarmScreen_makeAESConfig ( dyn_string &  dsExceptions)
Description:
Configure the AES for JCOP.
Usage:
Public.
Parameters
[out]dsExceptionsstring, A list of errors that happened during execution.
bool fwAlarmScreen_isAdmin ( )
Description:
Checks if the current user has administration rights. Called from fwAlarmScreenGeneric.
Usage:
Internal.
Returns
True if the current user has administration rights.
void fwAlarmScreen_applyFilter ( string  pvssAesPropertiesDp,
dyn_dyn_anytype  ddaAesFilter,
dyn_string &  dsExceptions,
bool  bUpdateAes = true 
)
Description:
Apply 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".
Usage
Public
Parameters
pvssAesPropertiesDpstring input, The PVSS runtime properties DP for the given alarm screen
ddaAesFilterdyn_dyn_anytype input, The filter object with the filter data is passed here
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
updateAesbool input, Do or not do aes_doRestart after setting the new filter (default do)
fwAlarmScreen_readFilter ( dyn_dyn_anytype &  ddaAesFilter,
dyn_string &  dsExceptions 
)
Description:
Reads the filter options from the alarm screen filter graphical objects.
Usage:
Public
Parameters
ddaAesFilterdyn_dyn_anytype output, The filter object is returned here with the filter as defined in the graphical objects.
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
fwAlarmScreen_showFilter ( dyn_dyn_anytype  ddaAesFilter,
dyn_string &  dsExceptions 
)
Description:
Shows the given filter options in the alarm screen filter graphical objects.
Usage:
Public.
Parameters
ddaAesFilterdyn_dyn_anytype input, The filter object with the filter data to display in the graphical objects.
dsExceptionsdyn_string output, List of errors that occurred during execution.
void fwAlarmScreen_saveFilter ( string  sFwAesConfigDp,
dyn_dyn_anytype  aesFilter,
dyn_string &  exceptionInfo 
)
Description:
Save the filter options to the given filter configuration data point.
Usage:
Public.
Parameters
sFwAesConfigDpThe filter configuration data point to write to
aesFilterThe filter object with the filter data is passed here. Use the fwAlarmScreen_CONFIG_OBJECT_FILTER_XXX constants to interpret the object
exceptionInfoDetails of any exceptions are returned here
fwAlarmScreen_loadFilter ( string  sFwAesConfigDp,
dyn_dyn_anytype &  ddaAesFilter,
dyn_string &  dsExceptions 
)
Description:
Read the filter options from the given filter configuration data point.
Usage
Public
Parameters
sFwAesConfigDpstring input, The filter configuration data point to read from.
ddaAesFilterdyn_dyn_anytype output, The filter with the loaded data.
dsExceptionsdyn_string output, List of errors that occurred during execution.
_fwAlarmScreen_getDefaultFilter ( dyn_dyn_anytype &  ddaAesFilter,
dyn_string &  dsExceptions 
)
Description:
Build a filter object configured with the default filter criteria (display all alarms).
Usage
Internal.
Parameters
ddaAesFilterdyn_dyn_anytype output, Filter displaying all alarms.
dsExceptionsdyn_string output, List of errors that occurred during execution.
void fwAlarmScreen_getQuickFilterList ( dyn_string &  dsQuickFilter,
dyn_string &  dsExceptions 
)
Description:
Get the list of available quick filters.
Usage:
Public.
Parameters
dsQuickFilterdyn_string output, The list of quick filters.
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
void fwAlarmScreen_reloadQuickFilterList ( )
Description:
Load the quick filter list and show it in the appropriate combo-box.
Usage:
Public.
void fwAlarmScreen_saveQuickFilterOptions ( string  fwAesConfigDp,
bool  isQuickFilter,
string  accessRight,
dyn_string &  exceptionInfo 
)
Description:
Save the current filter to the quick-list.
void fwAlarmScreen_loadQuickFilterOptions ( string  fwAesConfigDp,
bool &  isQuickFilter,
string &  accessRight,
dyn_string &  exceptionInfo 
)
Description:
Load a filter from the quick-list.
void fwAlarmScreen_getDefaultFilterName ( string &  defaultFilter,
dyn_string &  exceptionInfo 
)
Description:
Get the name of the default filter.
Usage:
Public.
Parameters
[out]defaultFilterstring, The default filter name.
[out]exceptionInfostring, Details of any exceptions are returned here.
fwAlarmScreen_readMode ( dyn_anytype &  daAesMode,
dyn_string &  dsExceptions 
)
Description:
Read the mode options from the alarm screen widgets.
Usage:
Public.
Parameters
daAesModedyn_anytype output, The mode object is returned here with the mode criteria as defined in the graphical objects
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
fwAlarmScreen_showMode ( dyn_anytype &  daAesMode,
dyn_string &  dsExceptions 
)
Descriptions:
Shows the given mode options in the alarm screen mode graphical objects.
Usage
Public
Parameters
daAesModedyn_anytype output, The mode object with the mode data to display in the graphical objects.
dsExceptionsdyn_string output, List of errors that occurred during execution.
fwAlarmScreen_applyMode ( string  sPropertiesDp,
dyn_anytype  aesMode,
dyn_string &  dsExceptions,
bool  updateAes = true 
)
Description:
Apply 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".
Usage:
Public.
Parameters
pvssAesPropertiesDpsring input, The PVSS runtime properties dp for the given alarm screen.
aesModedyn_anytype input, The mode object with the mode data is passed here.
dsExceptionsdyn_string output, List of errors that occurred during execution.
updateAesboolean input, Indicates whether or not to perform an aes_doRestart after setting the new mode. Default: do.
_fwAlarmScreen_getDefaultMode ( dyn_anytype &  daAesMode,
dyn_string &  dsExceptions 
)
Description:
Get a mode object configured with the default mode options for the alarm screen.
Usage
Internal.
Parameters
daAesModedyn_anytype output, The mode object is returned here with the default filter criteria.
dsExceptionsdyn_string output, List of errors that occurred during execution.
void fwAlarmScreen_initFields ( dyn_anytype &  daAesMode,
dyn_dyn_anytype &  ddaAesFilter,
dyn_string &  dsExceptions 
)
Description:
Build a filter from dollar parameters. Any non dollar-defined parameters will be replaced by a default value.
Usage:
Public.
Parameters
daAesModedyn_anytype output, The loaded AES mode.
ddaAesFilterdyn_dyn_anytype output, The generated filter.
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
void fwAlarmScreen_getDpsMatchingCriteria ( dyn_string  dsSystemNameFilters,
dyn_string  dpNameFilters,
dyn_string  dpAliasFilters,
dyn_string  dpTypeFilters,
dyn_string &  matchingDps,
dyn_string &  dsExceptions 
)
Description:
Returns a list of data points that match the given criteria. The result returned is as follows: result = ((dps that meet ALL DP name filter) && (dps that meet ALL DP alias filters)) of ANY specified type, on ANY specified system
Usage:
Public
Parameters
dsSystemNameFiltersdyn_string input, A list of systems to search in. The criteria are OR'ed
dpNameFiltersdyn_string input, A list of criteria to filter on the dp name. The criteria are AND'ed.
dpAliasFiltersdyn_string input, A list of criteria to filter on the dp alias. The criteria are AND'ed.
dpTypeFiltersdyn_string input, A list of data point types to search. The criteria are ORed.
matchingDpsdyn_string output, The list of matching dps is returned here.
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
void fwAlarmScreen_evaluateDpFilter ( dyn_dyn_anytype  ddaAesFilter,
dyn_string &  dsEvaluatedFilter,
dyn_string &  dsExceptions 
)
Description:
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.
Usage
Public
Parameters
ddaAesFilterdyn_dyn_anytype input, The filter object with the filter data is passed here.
dsEvaluatedFilterdyn_string output, The most compact form to express the result of the filter is returned here.
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
void fwAlarmScreen_evaluateSeverityFilter ( dyn_dyn_anytype  ddaAesFilter,
string &  sEvaluatedFilter,
dyn_string &  dsExceptions,
int  iLocalOrGlobal = 0 
)
Description:
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)
Usage:
Public
Parameters
ddaAesFilterdyn_dyn_anytype input, The filter object with the filter data is passed here
sEvaluatedFilterdyn_string output, The priority filter for the PVSS alarm screen is returned here
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
iLocalOrGlobalint input, 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)
void fwAlarmScreen_getColumnWidths ( dyn_string &  dsColumnName,
dyn_bool &  dbColumnVisible,
dyn_int &  diColumnWidth,
dyn_string &  dsExceptions 
)
Description:
Read the column names, visibility and widths of the alarm screen table in the current panel.
Usage:
Public
Parameters
dsColumnNamedyn_string output, The list of names of the columns that are in the current alarm screen table.
dbColumnVisibledyn_bool output, The visibility of each column. True visible, false invisible.
diColumnWidthdyn_int output, The width of each column.
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
void fwAlarmScreen_returnToDefaultView ( )
Description:
Set the view back to default filter and apply if necessary.
Usage:
Public
void fwAlarmScreen_getAccessControlOptions ( dyn_string &  dsAccessRights,
dyn_string &  dsExceptions 
)
Description:
Get the access rights for all possible actions.
Usage:
Public.
Parameters
dsAccessRightsdyn_string output, The access rights.
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
void fwAlarmScreen_setAccessControlOptions ( dyn_string  dsAccessRights,
dyn_string &  exceptionInfo 
)
Description:
Set the access rights for all possible actions.
Usage:
Public.
Parameters
dsAccessRightsdyn_string input, The access rights.
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
void fwAlarmScreen_limitButtonAccess ( )
Description:
Enable or disable buttons depending on user rights.
Usage:
Public.
void fwAlarmScreen_getDescriptionColumnBehaviour ( int &  iColumnBehaviour,
dyn_string &  dsExceptions 
)
Description:
Get 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.
Usage:
Public.
Parameters
iColumnBehaviourint output, any of the constants fwAlarmScreen_BEHAVIOUR_...
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
void fwAlarmScreen_getRowColourBehaviour ( bool &  bColorWholeRow,
dyn_string &  dsExceptions 
)
Description:
Indicate whether or not the whole row should be coloured.
Usage:
Public.
Parameters
bColorWholeRowbool output, True : do colour the row. False don't.
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
void fwAlarmScreen_setDescriptionColumnBehaviour ( int  iColumnBehaviour,
dyn_string &  dsExceptions 
)
Description:
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.
Usage:
Public.
Parameters
iColumnBehaviourint input, Any of the constants fwAlarmScreen_BEHAVIOUR_...
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
void fwAlarmScreen_setRowColourBehaviour ( bool  bColorWholeRow,
dyn_string &  dsExceptions 
)
Description:
Set wether or not the whole row should be colored.
Usage:
Public.
Parameters
bColorWholeRowbool intput, True : do color the row. False don't.
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
void fwAlarmScreen_showHideColumn ( string  sPvssAesPropertiesDp,
string  sColumnName,
bool  bVisible,
dyn_string &  dsExceptions,
bool  bUpdateAes = FALSE 
)
Description:
Change 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.
Usage:
Internal.
Parameters
sPvssAesPropertiesDpstring input, The PVSS runtime properties dp for the given alarm screen.
sColumnNamestring input, The name of the column to be hidden/shown.
bVisiblebool input, True to show the designated column, false to hide it.
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
bUpdateAesbool input, True to perform an aes_doRestart after the operation, false not to perform it.
void fwAlarmScreen_getShowHideColumn ( string  sPvssAesPropertiesDp,
string  sColumnName,
bool &  bVisible,
dyn_string &  dsExceptions 
)
Description:
Get 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.
Usage:
Internal.
Parameters
sPvssAesPropertiesDpstring input, The PVSS runtime properties DP for the given alarm screen.
sColumnNamestring input, The name of the column to be hidden/shown.
bVisiblebool output, True to show the designated column, false to hide it.
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
void fwAlarmScreen_setAesColumnVisibility ( const string &  sDpe)
Description:
Callback that will be triggered when the user modifies the visibility of the table columns AND saves the configuration. It will update the runtime properties DP to chane the visibility of the named columns in the Alarm Screen
Usage:
Internal.
Parameters
sDpestring input, The DPE that was modified and triggered this callback.
void fwAlarmScreen_showHideColumns ( string  sPvssAesPropertiesDp,
dyn_string  dsColumnName,
dyn_bool  dbVisible,
dyn_string &  dsExceptions,
bool  bUpdateAes = FALSE 
)
Description:
Change the visibility of the named columns in the Alarm Screen.
Usage:
Internal.
Parameters
sPvssAesPropertiesDpstring input, The PVSS runtime properties dp for the given alarm screen.
dsColumnNamedyn_string input, The names of the columns to be hidden/shown.
dbVisibledyn_bool input, True to show the corresponding column, false to hide it.
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
bUpdateAesbool input, True to perform an aes_doRestart after the operation, false not to perform it.
void fwAlarmScreen_setDefaultFilterName ( string  sDefaultFilter,
dyn_string &  dsExceptions 
)
Description:
Set the default filter to be loaded when the panel starts.
Usage:
Internal.
Parameters
sDefaultFilterstring input, The PVSS runtime properties dp for the given alarm screen.
dsExceptionsdyn_string output, List of exceptions that occurred during execution.
private string _fwAlarmScreen_getAlarmTableName ( )
Description:
Get the name of the currently active alarm table. We need this to get the right data when right clicking on an alarm. When selecting an alarm group we take table fwAlarmScreen_GROUP_ALARM_TABLE otherwise we take standard alarm table AES_TABLENAME_TOP.
Usage:
Internal.
Returns
string, The name of the active alarm table
dyn_string fwAlarmScreen_getRightClickMenuOptions ( int  iRow,
string  sColumn 
)
Description:
Return the list of possible right click menu options for line iRow and column sColumn.
Usage:
Internal.
Parameters
[in]iRowint, The line that was right-clicked.
[in]sColumnstring, The column that was right-clicked.
void fwAlarmScreen_treatRightClickAnswer ( int  iAnswer,
int  iRow,
string  sColumn 
)
Description:
Action on right-click menu selection.
Usage:
Internal.
Parameters
[in]iAnswerint, The ID of the element of the menu clicked.
[in]iRowint, The row that was right-clicked.
[in]sColumnstring, The column that was right-clicked.
void _fwAlarmScreen_showTrend ( mapping  mRowHeaderMapping,
int  iRow,
string  sPropertiesDp,
int  iTabType,
string  sTableName,
dyn_string &  dsExceptions 
)
Description:
Action on right-click => "Show trend".
Usage:
Internal.
Parameters
[in]mRowHeaderMappingmapping, Content of the right-clicked line. Key: column name, value: cell value.
[in]iRowint, The row that was right-clicked.
[in]sPropertiesDpstring, The AES properties DP for the current panel.
[in]iTabTypeint, Irrelevant (backward compatibility remain).
[in]sTableNamestring, The table that was clicked.
[out]dsExceptionsdyn_string, A list of errors that happened during the execution of the function.
void _fwAlarmScreen_showFsmPanel ( mapping  mRowHeaderMapping,
int  iRow,
string  sPropertiesDp,
int  iTabType,
string  sTableName,
dyn_string &  dsExceptions 
)
Description:
Action on right-click => "Show FSM panel".
Usage:
Internal.
Parameters
[in]mRowHeaderMappingmapping, Content of the right-clicked line. Key: column name, value: cell value.
[in]iRowint, The row that was right-clicked.
[in]sPropertiesDpstring, The AES properties DP for the current panel.
[in]iTabTypeint, Irrelevant (backward compatibility remain).
[in]sTableNamestring, The table that was clicked.
[out]dsExceptionsdyn_string, A list of errors that happened during the execution of the function.
void _fwAlarmScreen_showDetails ( mapping  mRowHeaderMapping,
int  iRow,
string  sPropertiesDp,
int  iTabType,
string  sTableName,
dyn_string &  dsExceptions 
)
Description:
Action on right-click => "Show details".
Usage:
Internal.
Parameters
[in]mRowHeaderMappingmapping, Content of the right-clicked line. Key: column name, value: cell value.
[in]iRowint, The row that was right-clicked.
[in]sPropertiesDpstring, The AES properties DP for the current panel.
[in]iTabTypeint, Irrelevant (backward compatibility remain).
[in]sTableNamestring, The table that was clicked.
[out]dsExceptionsdyn_string, A list of errors that happened during the execution of the function.
void _fwAlarmScreen_showCommentPanel ( mapping  mRowHeaderMapping,
int  iRow,
string  sPropertiesDp,
int  iTabType,
string  sTableName,
dyn_string &  dsExceptions 
)
Description:
Action on right-click => "Show Comment Panel".
Usage:
Internal.
Parameters
[in]mRowHeaderMappingmapping, Content of the right-clicked line. Key: column name, value: cell value.
[in]iRowint, The row that was right-clicked.
[in]sPropertiesDpstring, The AES properties DP for the current panel.
[in]iTabTypeint, Irrelevant (backward compatibility remain).
[in]sTableNamestring, The table that was clicked.
[out]dsExceptionsdyn_string, A list of errors that happened during the execution of the function.
void _fwAlarmScreen_showHelp ( mapping  mRowHeaderMapping,
int  iRow,
string  sPropertiesDp,
int  iTabType,
string  sTableName,
dyn_string &  dsExceptions 
)
Description:
Action on right-click => "Show help".
Usage:
Internal.
Parameters
[in]mRowHeaderMappingmapping, Content of the right-clicked line. Key: column name, value: cell value.
[in]iRowint, The row that was right-clicked.
[in]sPropertiesDpstring, The AES properties DP for the current panel.
[in]iTabTypeint, Irrelevant (backward compatibility remain).
[in]sTableNamestring, The table that was clicked.
[out]dsExceptionsdyn_string, A list of errors that happened during the execution of the function.
void fwAlarmScreen_getRightClickConfig ( dyn_string &  menuItems,
dyn_string &  menuFunctions,
dyn_string &  menuAlertTypes,
dyn_string &  exceptionInfo 
)
Description:
Get the right-click menu:
  • Item labels.
  • Item action function.
  • Item alert type: which alarm type this item can act on (summary, non summary, all).
Usage:
Internal.
Parameters
[out]menuItemsdyn_string, The list of menu entries labels.
[out]menuFunctionsdyn_string, The list of menu entries action functions.
[out]menuAlertTypesdyn_string, The list of menu entries alert types.
[out]exceptionInfodyn_string, A list of errors that happened during the execution of the function.
void _fwAlarmScreen_countDownToShowStopped ( )
Description:
Function started in a thread when the AES stops. It leave enough time for the alarm to restart by itself. If it restart the thread will be stopped before it ends.
Usage:
Internal.
void fwAlarmScreen_idleCheck ( )
Description:
Infinite loop thread that checks if the user is still active. If not, the alarm screen is set back to default view.
Usage:
Internal.
void fwAlarmScreen_updateOnlineValues ( )
Description:
Infinite loop that updates the content of the "Online value" column of the table if it is visible.
Usage:
Internal.
void fwAlarmScreen_userChanged ( const string  sUser)
Description:
Callback triggered when a new user logs in. Connection is internal (fwAlarmScreenGeneric).
Usage:
Public.
Parameters
sUserstring input, The user that just logged in.
void fwAlarmScreen_busyCallBack ( string  sDpe,
const int  iBusyState 
)
Description:
Callback triggered when the busy state of the AES changes.
Usage:
Public.
Parameters
sDpestring input, The DPE that triggered the callback.
iBusyStateint input, The new busy state (AES_BUSY_START or AES_BUSY_STOP).
void fwAlarmScreen_runningStateCallback ( string  sDpe,
unsigned  uRunMode 
)
Description:
Callback triggered when the AES stops without reason. If it is isn't restarted within the next X seconds, it will restart it.
Usage:
Internal.
Parameters
[in]sDpestring, Irrelevant.
[in]uRunModeunsigned, The new run mode.
void fwAlarmScreen_eventHandler ( const string  sDp,
const int  iEvent 
)
Description:
Callback triggered on custom or generic alarm screen event.
Usage:
Internal.
Parameters
sDpstring input, The DPE that triggered the callback.
iEventint input, The event. See constants FWALARMSCREEN_GENERIC_CONFIG_EVENT_xxx or custom events.
void fwAlarmScreen_copyTableStyle ( const string  sTableSource,
const string  sTableDest 
)
Description:
Copy the formatting of a table to another one. This includes the colours and the columns (name, header, size, visibility, ...).
Usage:
Public.
Parameters
sTableSourcestring input, The table to copy the parameters from.
sTableDeststring input, The table to copy the parameters to.
void fwAlarmScreen_resizePanel ( )
Description:
Resize the main panel to properly show the footer. To be called on expanding event.
Usage:
Public.
void fwAlarmScreen_saveConfig ( )
Description:
Save the panel configuration. To be called from fwAlarmScreenOptions panel.
Usage:
Internal.
dyn_string fwAlarmScreen_getConfigPanels ( )
Description:
Get the list of configuration panels to be show in the main configuration window.
Usage:
Internal.
Returns
The list of configuration panels to be show in the main configuration window.
dyn_string fwAlarmScreen_getShowableColumns ( )
Description:
Get the list of columns that can be shown/hidden.
Usage:
Internal.
Returns
The list of columns that can be shown/hidden.
void fwAlarmScreen_reloadConfig ( )
Description:
Reload the config after it has changed.
void fwAlarmScreen_closePanel ( )
Description:
Function called when closing the panel.
Usage:
Internal.
fwAlarmScreen_openScreenWithGroup ( bool  bAsNewModule,
bool  bStayOnTopOrModal,
string  sModuleName,
string  sPanelName,
string  sGroupName,
dyn_string &  exceptionInfo,
unsigned  x = 0,
unsigned  y = 0 
)
Opens a JCOP Alarm Screen with the specified group selected
Constraints
None
Usage
Public
PVSS managers
UI
Parameters
bAsNewModuleinput, should the display be opened in a new module, TRUE = new module, FALSE = child panel
bStayOnTopOrModalinput, for a new module - TRUE = stay on top, FALSE = normal behaviour for a child panel - TRUE = modal child panel, FALSE = normal behaviour
sModuleNameinput, the name of the new module (if required)
sPanelNameinput, the name of the new panel
sGroupNameinput, the name of the group to be selected once the alarm screen is open
exceptionInfoDetails of any exceptions are returned here
xinput, Optional parameter - default value 0. X position of the new display
yinput, Optional parameter - default value 0. Y position of the new display
fwAlarmScreen_openScreen ( bool  bAsNewModule,
bool  bStayOnTopOrModal,
string  sModuleName,
string  sPanelName,
dyn_string  dollarParams,
dyn_string &  exceptionInfo,
unsigned  x = 0,
unsigned  y = 0 
)
Opens a JCOP Alarm Screen with dollar parameters
Constraints
None
Usage
Public
PVSS managers
UI
Parameters
bAsNewModuleinput, should the display be opened in a new module, TRUE = new module, FALSE = child panel
bStayOnTopOrModalinput, for a new module - TRUE = stay on top, FALSE = normal behaviour for a child panel - TRUE = modal child panel, FALSE = normal behaviour
sModuleNameinput, the name of the new module (if required)
sPanelNameinput, the name of the new panel
exceptionInfoDetails of any exceptions are returned here
xinput, Optional parameter - default value 0. X position of the new display
yinput, Optional parameter - default value 0. Y position of the new display
void fwAlarmScreen_alarmFilter_init ( )
Description:
Initialize the alarm filter part of the alarm screen.
Usage:
Public.