fwAlarmHandling
8.4.2
|
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 () |
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.
void fwAlarmScreen_initUIElements | ( | ) |
void fwAlarmScreen_initAES | ( | string | sLoadFilter = "" | ) |
[in] | sLoadFilter | string, The filter to load on initialization. |
bool fwAlarmScreen_checkAESConfig | ( | ) |
void fwAlarmScreen_makeAESConfig | ( | dyn_string & | dsExceptions | ) |
[out] | dsExceptions | string, A list of errors that happened during execution. |
bool fwAlarmScreen_isAdmin | ( | ) |
void fwAlarmScreen_applyFilter | ( | string | pvssAesPropertiesDp, |
dyn_dyn_anytype | ddaAesFilter, | ||
dyn_string & | dsExceptions, | ||
bool | bUpdateAes = true |
||
) |
pvssAesPropertiesDp | string input, The PVSS runtime properties DP for the given alarm screen |
ddaAesFilter | dyn_dyn_anytype input, The filter object with the filter data is passed here |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
updateAes | bool input, Do or not do aes_doRestart after setting the new filter (default do) |
fwAlarmScreen_readFilter | ( | dyn_dyn_anytype & | ddaAesFilter, |
dyn_string & | dsExceptions | ||
) |
ddaAesFilter | dyn_dyn_anytype output, The filter object is returned here with the filter as defined in the graphical objects. |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
fwAlarmScreen_showFilter | ( | dyn_dyn_anytype | ddaAesFilter, |
dyn_string & | dsExceptions | ||
) |
ddaAesFilter | dyn_dyn_anytype input, The filter object with the filter data to display in the graphical objects. |
dsExceptions | dyn_string output, List of errors that occurred during execution. |
void fwAlarmScreen_saveFilter | ( | string | sFwAesConfigDp, |
dyn_dyn_anytype | aesFilter, | ||
dyn_string & | exceptionInfo | ||
) |
sFwAesConfigDp | The filter configuration data point to write to |
aesFilter | The filter object with the filter data is passed here. Use the fwAlarmScreen_CONFIG_OBJECT_FILTER_XXX constants to interpret the object |
exceptionInfo | Details of any exceptions are returned here |
fwAlarmScreen_loadFilter | ( | string | sFwAesConfigDp, |
dyn_dyn_anytype & | ddaAesFilter, | ||
dyn_string & | dsExceptions | ||
) |
sFwAesConfigDp | string input, The filter configuration data point to read from. |
ddaAesFilter | dyn_dyn_anytype output, The filter with the loaded data. |
dsExceptions | dyn_string output, List of errors that occurred during execution. |
_fwAlarmScreen_getDefaultFilter | ( | dyn_dyn_anytype & | ddaAesFilter, |
dyn_string & | dsExceptions | ||
) |
ddaAesFilter | dyn_dyn_anytype output, Filter displaying all alarms. |
dsExceptions | dyn_string output, List of errors that occurred during execution. |
void fwAlarmScreen_getQuickFilterList | ( | dyn_string & | dsQuickFilter, |
dyn_string & | dsExceptions | ||
) |
dsQuickFilter | dyn_string output, The list of quick filters. |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
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 | ||
) |
[out] | defaultFilter | string, The default filter name. |
[out] | exceptionInfo | string, Details of any exceptions are returned here. |
fwAlarmScreen_readMode | ( | dyn_anytype & | daAesMode, |
dyn_string & | dsExceptions | ||
) |
daAesMode | dyn_anytype output, The mode object is returned here with the mode criteria as defined in the graphical objects |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
fwAlarmScreen_showMode | ( | dyn_anytype & | daAesMode, |
dyn_string & | dsExceptions | ||
) |
daAesMode | dyn_anytype output, The mode object with the mode data to display in the graphical objects. |
dsExceptions | dyn_string output, List of errors that occurred during execution. |
fwAlarmScreen_applyMode | ( | string | sPropertiesDp, |
dyn_anytype | aesMode, | ||
dyn_string & | dsExceptions, | ||
bool | updateAes = true |
||
) |
pvssAesPropertiesDp | sring input, The PVSS runtime properties dp for the given alarm screen. |
aesMode | dyn_anytype input, The mode object with the mode data is passed here. |
dsExceptions | dyn_string output, List of errors that occurred during execution. |
updateAes | boolean 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 | ||
) |
daAesMode | dyn_anytype output, The mode object is returned here with the default filter criteria. |
dsExceptions | dyn_string output, List of errors that occurred during execution. |
void fwAlarmScreen_initFields | ( | dyn_anytype & | daAesMode, |
dyn_dyn_anytype & | ddaAesFilter, | ||
dyn_string & | dsExceptions | ||
) |
daAesMode | dyn_anytype output, The loaded AES mode. |
ddaAesFilter | dyn_dyn_anytype output, The generated filter. |
dsExceptions | dyn_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 | ||
) |
dsSystemNameFilters | dyn_string input, A list of systems to search in. The criteria are OR'ed |
dpNameFilters | dyn_string input, A list of criteria to filter on the dp name. The criteria are AND'ed. |
dpAliasFilters | dyn_string input, A list of criteria to filter on the dp alias. The criteria are AND'ed. |
dpTypeFilters | dyn_string input, A list of data point types to search. The criteria are ORed. |
matchingDps | dyn_string output, The list of matching dps is returned here. |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
void fwAlarmScreen_evaluateDpFilter | ( | dyn_dyn_anytype | ddaAesFilter, |
dyn_string & | dsEvaluatedFilter, | ||
dyn_string & | dsExceptions | ||
) |
ddaAesFilter | dyn_dyn_anytype input, The filter object with the filter data is passed here. |
dsEvaluatedFilter | dyn_string output, The most compact form to express the result of the filter is returned here. |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
void fwAlarmScreen_evaluateSeverityFilter | ( | dyn_dyn_anytype | ddaAesFilter, |
string & | sEvaluatedFilter, | ||
dyn_string & | dsExceptions, | ||
int | iLocalOrGlobal = 0 |
||
) |
ddaAesFilter | dyn_dyn_anytype input, The filter object with the filter data is passed here |
sEvaluatedFilter | dyn_string output, The priority filter for the PVSS alarm screen is returned here |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
iLocalOrGlobal | int 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 | ||
) |
dsColumnName | dyn_string output, The list of names of the columns that are in the current alarm screen table. |
dbColumnVisible | dyn_bool output, The visibility of each column. True visible, false invisible. |
diColumnWidth | dyn_int output, The width of each column. |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
void fwAlarmScreen_returnToDefaultView | ( | ) |
void fwAlarmScreen_getAccessControlOptions | ( | dyn_string & | dsAccessRights, |
dyn_string & | dsExceptions | ||
) |
dsAccessRights | dyn_string output, The access rights. |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
void fwAlarmScreen_setAccessControlOptions | ( | dyn_string | dsAccessRights, |
dyn_string & | exceptionInfo | ||
) |
dsAccessRights | dyn_string input, The access rights. |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
void fwAlarmScreen_limitButtonAccess | ( | ) |
void fwAlarmScreen_getDescriptionColumnBehaviour | ( | int & | iColumnBehaviour, |
dyn_string & | dsExceptions | ||
) |
iColumnBehaviour | int output, any of the constants fwAlarmScreen_BEHAVIOUR_... |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
void fwAlarmScreen_getRowColourBehaviour | ( | bool & | bColorWholeRow, |
dyn_string & | dsExceptions | ||
) |
bColorWholeRow | bool output, True : do colour the row. False don't. |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
void fwAlarmScreen_setDescriptionColumnBehaviour | ( | int | iColumnBehaviour, |
dyn_string & | dsExceptions | ||
) |
iColumnBehaviour | int input, Any of the constants fwAlarmScreen_BEHAVIOUR_... |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
void fwAlarmScreen_setRowColourBehaviour | ( | bool | bColorWholeRow, |
dyn_string & | dsExceptions | ||
) |
bColorWholeRow | bool intput, True : do color the row. False don't. |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
void fwAlarmScreen_showHideColumn | ( | string | sPvssAesPropertiesDp, |
string | sColumnName, | ||
bool | bVisible, | ||
dyn_string & | dsExceptions, | ||
bool | bUpdateAes = FALSE |
||
) |
sPvssAesPropertiesDp | string input, The PVSS runtime properties dp for the given alarm screen. |
sColumnName | string input, The name of the column to be hidden/shown. |
bVisible | bool input, True to show the designated column, false to hide it. |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
bUpdateAes | bool 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 | ||
) |
sPvssAesPropertiesDp | string input, The PVSS runtime properties DP for the given alarm screen. |
sColumnName | string input, The name of the column to be hidden/shown. |
bVisible | bool output, True to show the designated column, false to hide it. |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
void fwAlarmScreen_setAesColumnVisibility | ( | const string & | sDpe | ) |
sDpe | string 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 |
||
) |
sPvssAesPropertiesDp | string input, The PVSS runtime properties dp for the given alarm screen. |
dsColumnName | dyn_string input, The names of the columns to be hidden/shown. |
dbVisible | dyn_bool input, True to show the corresponding column, false to hide it. |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
bUpdateAes | bool input, True to perform an aes_doRestart after the operation, false not to perform it. |
void fwAlarmScreen_setDefaultFilterName | ( | string | sDefaultFilter, |
dyn_string & | dsExceptions | ||
) |
sDefaultFilter | string input, The PVSS runtime properties dp for the given alarm screen. |
dsExceptions | dyn_string output, List of exceptions that occurred during execution. |
private string _fwAlarmScreen_getAlarmTableName | ( | ) |
dyn_string fwAlarmScreen_getRightClickMenuOptions | ( | int | iRow, |
string | sColumn | ||
) |
[in] | iRow | int, The line that was right-clicked. |
[in] | sColumn | string, The column that was right-clicked. |
void fwAlarmScreen_treatRightClickAnswer | ( | int | iAnswer, |
int | iRow, | ||
string | sColumn | ||
) |
[in] | iAnswer | int, The ID of the element of the menu clicked. |
[in] | iRow | int, The row that was right-clicked. |
[in] | sColumn | string, The column that was right-clicked. |
void _fwAlarmScreen_showTrend | ( | mapping | mRowHeaderMapping, |
int | iRow, | ||
string | sPropertiesDp, | ||
int | iTabType, | ||
string | sTableName, | ||
dyn_string & | dsExceptions | ||
) |
[in] | mRowHeaderMapping | mapping, Content of the right-clicked line. Key: column name, value: cell value. |
[in] | iRow | int, The row that was right-clicked. |
[in] | sPropertiesDp | string, The AES properties DP for the current panel. |
[in] | iTabType | int, Irrelevant (backward compatibility remain). |
[in] | sTableName | string, The table that was clicked. |
[out] | dsExceptions | dyn_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 | ||
) |
[in] | mRowHeaderMapping | mapping, Content of the right-clicked line. Key: column name, value: cell value. |
[in] | iRow | int, The row that was right-clicked. |
[in] | sPropertiesDp | string, The AES properties DP for the current panel. |
[in] | iTabType | int, Irrelevant (backward compatibility remain). |
[in] | sTableName | string, The table that was clicked. |
[out] | dsExceptions | dyn_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 | ||
) |
[in] | mRowHeaderMapping | mapping, Content of the right-clicked line. Key: column name, value: cell value. |
[in] | iRow | int, The row that was right-clicked. |
[in] | sPropertiesDp | string, The AES properties DP for the current panel. |
[in] | iTabType | int, Irrelevant (backward compatibility remain). |
[in] | sTableName | string, The table that was clicked. |
[out] | dsExceptions | dyn_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 | ||
) |
[in] | mRowHeaderMapping | mapping, Content of the right-clicked line. Key: column name, value: cell value. |
[in] | iRow | int, The row that was right-clicked. |
[in] | sPropertiesDp | string, The AES properties DP for the current panel. |
[in] | iTabType | int, Irrelevant (backward compatibility remain). |
[in] | sTableName | string, The table that was clicked. |
[out] | dsExceptions | dyn_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 | ||
) |
[in] | mRowHeaderMapping | mapping, Content of the right-clicked line. Key: column name, value: cell value. |
[in] | iRow | int, The row that was right-clicked. |
[in] | sPropertiesDp | string, The AES properties DP for the current panel. |
[in] | iTabType | int, Irrelevant (backward compatibility remain). |
[in] | sTableName | string, The table that was clicked. |
[out] | dsExceptions | dyn_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 | ||
) |
[out] | menuItems | dyn_string, The list of menu entries labels. |
[out] | menuFunctions | dyn_string, The list of menu entries action functions. |
[out] | menuAlertTypes | dyn_string, The list of menu entries alert types. |
[out] | exceptionInfo | dyn_string, A list of errors that happened during the execution of the function. |
void _fwAlarmScreen_countDownToShowStopped | ( | ) |
void fwAlarmScreen_idleCheck | ( | ) |
void fwAlarmScreen_updateOnlineValues | ( | ) |
void fwAlarmScreen_userChanged | ( | const string | sUser | ) |
sUser | string input, The user that just logged in. |
void fwAlarmScreen_busyCallBack | ( | string | sDpe, |
const int | iBusyState | ||
) |
sDpe | string input, The DPE that triggered the callback. |
iBusyState | int input, The new busy state (AES_BUSY_START or AES_BUSY_STOP). |
void fwAlarmScreen_runningStateCallback | ( | string | sDpe, |
unsigned | uRunMode | ||
) |
[in] | sDpe | string, Irrelevant. |
[in] | uRunMode | unsigned, The new run mode. |
void fwAlarmScreen_eventHandler | ( | const string | sDp, |
const int | iEvent | ||
) |
sDp | string input, The DPE that triggered the callback. |
iEvent | int input, The event. See constants FWALARMSCREEN_GENERIC_CONFIG_EVENT_xxx or custom events. |
void fwAlarmScreen_copyTableStyle | ( | const string | sTableSource, |
const string | sTableDest | ||
) |
sTableSource | string input, The table to copy the parameters from. |
sTableDest | string input, The table to copy the parameters to. |
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 |
||
) |
Opens a JCOP Alarm Screen with the specified group selected
bAsNewModule | input, should the display be opened in a new module, TRUE = new module, FALSE = child panel |
bStayOnTopOrModal | input, for a new module - TRUE = stay on top, FALSE = normal behaviour for a child panel - TRUE = modal child panel, FALSE = normal behaviour |
sModuleName | input, the name of the new module (if required) |
sPanelName | input, the name of the new panel |
sGroupName | input, the name of the group to be selected once the alarm screen is open |
exceptionInfo | Details of any exceptions are returned here |
x | input, Optional parameter - default value 0. X position of the new display |
y | input, 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
bAsNewModule | input, should the display be opened in a new module, TRUE = new module, FALSE = child panel |
bStayOnTopOrModal | input, for a new module - TRUE = stay on top, FALSE = normal behaviour for a child panel - TRUE = modal child panel, FALSE = normal behaviour |
sModuleName | input, the name of the new module (if required) |
sPanelName | input, the name of the new panel |
exceptionInfo | Details of any exceptions are returned here |
x | input, Optional parameter - default value 0. X position of the new display |
y | input, Optional parameter - default value 0. Y position of the new display |
void fwAlarmScreen_alarmFilter_init | ( | ) |