fwAlarmHandling
8.4.1
|
Functions | |
fwAlarmHandling_getDpsMatchingCriteria (dyn_string systemNameFilters, dyn_string dpNameFilters, dyn_string dpAliasFilters, dyn_string dpTypeFilters, dyn_string &matchingDps, dyn_string &exceptionInfo) | |
fwAlarmHandling_openScreen (bool bAsNewModule, bool bStayOnTopOrModal, string sModuleName, string sPanelName, dyn_string &exceptionInfo, unsigned x=0, unsigned y=0) | |
fwAlarmHandling_openScreenWithDpeList (dyn_string dpeList, bool bAsNewModule, bool bStayOnTopOrModal, string sModuleName, string sPanelName, dyn_string &exceptionInfo, unsigned x=0, unsigned y=0) | |
fwAlarmHandling_openScreenWithSavedFilter (string filterName, bool bAsNewModule, bool bStayOnTopOrModal, string sModuleName, string sPanelName, dyn_string &exceptionInfo, unsigned x=0, unsigned y=0) | |
fwAlarmHandling_openScreenWithFilter (dyn_dyn_anytype filter, bool bAsNewModule, bool bStayOnTopOrModal, string sModuleName, string sPanelName, dyn_string &exceptionInfo, unsigned x=0, unsigned y=0, string sFilterName="") | |
bool | fwAlarmHandling_AESConfig_isForFw () |
bool | fwAlarmHandling_AESConfig_isForUn () |
bool | fwAlarmHandling_AESConfig_useFwConfig (dyn_string exceptionInfo) |
bool | fwAlarmHandling_AESConfig_useUnConfig (dyn_string exceptionInfo) |
This library contains functions for handling JCOP framework alarms. There are functions for filtering data points which have alarms as well as functions to open the JCOP Alarm Screen
25/06/2012: Marco Boccioli
12/06/2012: Marco Boccioli
29/06/2011 Marco Boccioli
2011-07-05 Marco Boccioli
fwAlarmHandling_getDpsMatchingCriteria | ( | dyn_string | systemNameFilters, |
dyn_string | dpNameFilters, | ||
dyn_string | dpAliasFilters, | ||
dyn_string | dpTypeFilters, | ||
dyn_string & | matchingDps, | ||
dyn_string & | exceptionInfo | ||
) |
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
systemNameFilters | A list of systems to search in. The criteria are OR'ed |
dpNameFilters | A list of criteria to filter on the dp name. The criteria are AND'ed. |
dpAliasFilters | A list of criteria to filter on the dp alias. The criteria are AND'ed. |
dpTypeFilters | A list of data point types to search. The criteria are ORed. |
matchingDps | The list of matching dps is returned here. |
exceptionInfo | Details of any exceptions are returned here |
fwAlarmHandling_openScreen | ( | bool | bAsNewModule, |
bool | bStayOnTopOrModal, | ||
string | sModuleName, | ||
string | sPanelName, | ||
dyn_string & | exceptionInfo, | ||
unsigned | x = 0 , |
||
unsigned | y = 0 |
||
) |
Opens a JCOP Alarm Screen with the default filter - filter shows ALL alarms in ALL systems.
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 |
fwAlarmHandling_openScreenWithDpeList | ( | dyn_string | dpeList, |
bool | bAsNewModule, | ||
bool | bStayOnTopOrModal, | ||
string | sModuleName, | ||
string | sPanelName, | ||
dyn_string & | exceptionInfo, | ||
unsigned | x = 0 , |
||
unsigned | y = 0 |
||
) |
Opens a JCOP Alarm Screen to monitor a specific list of DPEs.
dpeList | input, the list of data points or data point elements that the alarm screen should monitor and display |
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 |
fwAlarmHandling_openScreenWithSavedFilter | ( | string | filterName, |
bool | bAsNewModule, | ||
bool | bStayOnTopOrModal, | ||
string | sModuleName, | ||
string | sPanelName, | ||
dyn_string & | exceptionInfo, | ||
unsigned | x = 0 , |
||
unsigned | y = 0 |
||
) |
Opens a JCOP Alarm Screen with the specified pre-saved filter.
filterName | input, the name of the pre-saved filter that should be loaded and displayed |
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 |
fwAlarmHandling_openScreenWithFilter | ( | dyn_dyn_anytype | filter, |
bool | bAsNewModule, | ||
bool | bStayOnTopOrModal, | ||
string | sModuleName, | ||
string | sPanelName, | ||
dyn_string & | exceptionInfo, | ||
unsigned | x = 0 , |
||
unsigned | y = 0 , |
||
string | sFilterName = "" |
||
) |
Opens a JCOP Alarm Screen with the specified custom filter.
filter | input, the filter shoule be passed here, check the fwAlarmHandlingScreen_CONFIG_OBJECT_FILTER_XXX constants that define the filter object |
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 |
sFilterName | input, Optional parameter - default value "". Filter name to be shown on the Quick Filters box |
bool fwAlarmHandling_AESConfig_isForFw | ( | ) |
Checks if the alarm screen configuration stored in _AESConfig is the one for JCOP FW.
bool fwAlarmHandling_AESConfig_isForUn | ( | ) |
Checks if the alarm screen configuration stored in _AESConfig is the one for UNICOS.
bool fwAlarmHandling_AESConfig_useFwConfig | ( | dyn_string | exceptionInfo | ) |
Applies the alarm screen configuration (stored in _AESConfig) for the JCOP FW.
exceptionInfo | errors returned here |
bool fwAlarmHandling_AESConfig_useUnConfig | ( | dyn_string | exceptionInfo | ) |
Applies the alarm screen configuration (stored in _AESConfig) for the UNICOS.
exceptionInfo | errors returned here |