unAlarmScreenNg
0.9.5
|
Functions | |
Public functions | |
mapping | AlarmScreenUNICOS_getFilterCompletions (string sPropName, const dyn_string &dsSelectedSystems) |
mapping | AlarmScreenUNICOS_getSlaveFilterCompletions (string sPropName, const mapping &mFilters) |
void | AlarmScreenUNICOS_mouseTableEvent (const mapping &mArgs) |
void | AlarmScreenUNICOS_ctrlActionRequested (const mapping &mArgs) |
mapping | AlarmScreenUNICOS_mouseTableEvent_broken (const mapping &mSource, const mapping &mAlarmData) |
mapping | AlarmScreenUNICOS_treatRightClickAnswer (const mapping &mSource, const mapping &mAlarmData, const dyn_string &dsMenu, int iAnswer) |
Private functions: initialization of some globals for UNICOS UI | |
private void | _AlarmScreenUNICOS_initHMI () |
private void | _AlarmScreenUNICOS_basicConfigApplied (const mapping &mArgs) |
Private functions: processing of filter completions | |
private void | _AlarmScreenUNICOS_getFilterCompletions_application (const dyn_string &dsSelectedSystems, mapping &mResult) |
private dyn_string | _AlarmScreenUNICOS_getSystemApplications (string sSystemName, string sFileNameSuffix="_unTreeDeviceOverview_FECharacteristics.dat") |
private void | _AlarmScreenUNICOS_getFilterCompletions_deviceType (const dyn_string &dsSelectedSystems, mapping &mResult) |
private void | _AlarmScreenUNICOS_getFilterCompletions_alarmType (const dyn_string &dsSelectedSystems, mapping &mResult) |
private void | _AlarmScreenUNICOS_getFilterCompletions_domain (const dyn_string &dsSelectedSystems, mapping &mResult) |
private void | _AlarmScreenUNICOS_getFilterCompletions_nature (const dyn_string &dsSelectedSystems, mapping &mResult) |
private void | _AlarmScreenUNICOS_getSubSystemFromFile (string sSystemName, int iSubSysIndex, dyn_string &dsResult, string sFileNameSuffix="_unTreeDeviceOverview_subSystem.dat") |
Private functions: preparing popup menu | |
private dyn_string | _AlarmScreenUNICOS_buildMenu (const mapping &mSource, const mapping &mAlarmData, int iMode) |
private dyn_string | _AlarmScreenUNICOS_buildBaseDpeMenu (string sDpe, string &sAlias, string &sDpType) |
private void | _AlarmScreenUNICOS_extendBaseDpeMenu (string sAlias, dyn_string &dsMenuList, int iMode) |
private dyn_string | _AlarmScreenUNICOS_buildColumnSubMenu (const mapping &mSource) |
private void | _AlarmScreenUNICOS_buildFinalMenu (dyn_string &dsMenuList, const dyn_string &dsColumnsMenu, int iMode, bool bDpeExists) |
private void | _AlarmScreenUNICOS_enableDisableAckMenu (const mapping &mSource, const mapping &mAlarmData, dyn_string &dsMenuList, int iMode) |
private void | _AlarmScreenUNICOS_disableMenuItem (dyn_string &dsMenuList, const string &sItemType, const string &sItemLabel) |
Private functions: processing of user selection from popup menu | |
private void | _AlarmScreenUNICOS_menuCpcGenericAction (const mapping &mSource, const mapping &mAlarmData, const dyn_string &dsMenu, int iAnswer) |
private bool | _AlarmScreenUNICOS_menuAlarmSpecific (const mapping &mSource, const mapping &mAlarmData, int iAnswer) |
private bool | _AlarmScreenUNICOS_menuLineToClipboard (const mapping &mSource, const mapping &mAlarmData) |
private bool | _AlarmScreenUNICOS_menuShowAllColumns (const mapping &mSource) |
private bool | _AlarmScreenUNICOS_menuShowHideColumn (const mapping &mSource, int iColumnIdx) |
private bool | _AlarmScreenUNICOS_menuDisplayAlarmDetails (const mapping &mSource, const mapping &mAlarmData) |
private bool | _AlarmScreenUNICOS_menuInsertComment (const mapping &mSource, const mapping &mAlarmData) |
private void | _AlarmScreenUNICOS_ackMultiple (dyn_mapping &dmAlarms) |
The replacement (copy) of some functions used from unAlarm componebt | |
private void | _AlarmScreenUNICOS_defaultPanel (string sDeviceName, string sDescription) |
Variables | |
UNICOS-specific names of alarm properties, as they appear in alarm data mapping from AS EWO | |
const string | ALARM_PROP_UN_TIME_UTC = "timeUtc" |
UTC alarm time. | |
const string | ALARM_PROP_UN_APPLCIATION = "application" |
UNICOS application name. | |
const string | ALARM_PROP_UN_DEVICE_TYPE = "deviceType" |
UNICOS device type name. | |
const string | ALARM_PROP_UN_ALIAS = "alias" |
DP alias. | |
const string | ALARM_PROP_UN_DOMAIN = "domain" |
UNICOS device domain name. | |
const string | ALARM_PROP_UN_NATURE = "nature" |
UNICOS device nature name. | |
const string | ALARM_PROP_UN_DESCRIPTION = "description" |
UNICOS device description. | |
const string | ALARM_PROP_UN_ALARM_TYPE = "alarmType" |
UNICOS alarm type. | |
const string | ALARM_PROP_UN_MASTER = "master" |
UNICOS master device name (for AA and DA) | |
const string | ALARM_PROP_UN_ALARM_LEVEL = "alarmLevel" |
UNICOS alarm level (0/1/2/3 = Info/Warning/Alarm/Safety alarm) | |
const string | ALARM_PROP_UN_PANEL = "unPanel" |
UNICOS device panel name. | |
const string | ALARM_PROP_UN_S = "s" |
UNICOS column titled 'S', see mouseTableEvent. | |
Replacement for constances declared in unAlarmScreen.ctl in order to remove dependency on that library | |
const string | AS_NG_UN_ALARM_FILTER_ALL = "*" |
Replacement for UNALARMSCREEN_FILTER_ALL: the string that appears in filter with meaning 'all'. | |
const string | AS_NG_UN_ALARM_LIST = "List..." |
Replacement for UNALARMSCREEN_LIST_NAME: the string that appears in selection list of combobox. | |
const int | AS_NG_UN_MENU_INDEX_COPY_LINE = 100000 |
Replacement for UNALARMSCREEN_POPUPMENU_INDEX_COPY_LINE: the index of popup menu item "Copy to clipboard". | |
private const string | ASNG_UN_DBG = "ASNG_DBG" |
Flag for activating debug messages in this library, one flag for all functions. | |
UNICOS-cpecific support for NextGen Alarm Screen
mapping AlarmScreenUNICOS_getFilterCompletions | ( | string | sPropName, |
const dyn_string & | dsSelectedSystems | ||
) |
Get list of comletions for filter on given alarm property
sPropName | The name of alarm property for which filter is configured |
dsSelectedSystems | The list of selected system names |
mapping AlarmScreenUNICOS_getSlaveFilterCompletions | ( | string | sPropName, |
const mapping & | mFilters | ||
) |
Get list of comletions for slave filter on given alarm property
sPropName | The name of alarm property for which filter is configured |
mFilters | Current settings for all 'master' filters of this slave:
|
void AlarmScreenUNICOS_mouseTableEvent | ( | const mapping & | mArgs | ) |
Process mouse event in alarm table cell. TODO - code and description The variant of calling this from C++ code doesn't work for UNICOS, postponed...
void AlarmScreenUNICOS_ctrlActionRequested | ( | const mapping & | mArgs | ) |
Process ctrlActionRequested() event of AS EWO in UNICOS-specific way
mArgs | event arguments, see function AlarmScreenNgEwo_ctrlActionRequested() |
mapping AlarmScreenUNICOS_mouseTableEvent_broken | ( | const mapping & | mSource, |
const mapping & | mAlarmData | ||
) |
Process mouse event in alarm table cell. TODO - code and description The variant of calling this from C++ code doesn't work for UNICOS, postponed...
mapping AlarmScreenUNICOS_treatRightClickAnswer | ( | const mapping & | mSource, |
const mapping & | mAlarmData, | ||
const dyn_string & | dsMenu, | ||
int | iAnswer | ||
) |
Process user selection from popup menu on alarm table. The whole logic of processing follows the logic of unAlarmScreen_treatRightClickAnswer(), as much as possible.
mSource | Parameters of event source (what row/column in table was clicked, mouse pointer position etc.) |
mAlarmData | Properties of all alarms, selected in the table |
dsMenu | The description of popup menu that was hown to user |
iAnswer | The ID of menu item, selected by user |
private void _AlarmScreenUNICOS_initHMI | ( | ) |
Simplified version of unGraphicalFrame_initHMI(), the main differences are:
private void _AlarmScreenUNICOS_basicConfigApplied | ( | const mapping & | mArgs | ) |
Process ctrlActionRequested() event of AS EWO in UNICOS-specific way; the case when event is AS_EWO_ACTION_BASIC_CONFIG_APPLIED. The main goal of this method is performing UNICOS-specific initialization of AS EWO
mArgs | event arguments, see function AlarmScreenNgEwo_ctrlActionRequested() |
private void _AlarmScreenUNICOS_getFilterCompletions_application | ( | const dyn_string & | dsSelectedSystems, |
mapping & | mResult | ||
) |
Get completions for filter on application name
dsSelectedSystems | The list of selected system names |
mResult | mapping where result shall be placed, 3 fields are available (keys are strings):
|
private dyn_string _AlarmScreenUNICOS_getSystemApplications | ( | string | sSystemName, |
string | sFileNameSuffix = "_unTreeDeviceOverview_FECharacteristics.dat" |
||
) |
Get list of applications for given system name. This is a bit simplified version of function _unTreeDeviceOverview_getFrontEndNameApplicationFromFile()
sSystemName | The name of system |
sFileNameSuffix | Suffix for file name with information |
private void _AlarmScreenUNICOS_getFilterCompletions_deviceType | ( | const dyn_string & | dsSelectedSystems, |
mapping & | mResult | ||
) |
Get completions for filter on device type
dsSelectedSystems | The list of selected system names |
mResult | mapping where result shall be placed, 3 fields are available (keys are strings):
|
private void _AlarmScreenUNICOS_getFilterCompletions_alarmType | ( | const dyn_string & | dsSelectedSystems, |
mapping & | mResult | ||
) |
Get completions for filter on alarm type
dsSelectedSystems | The list of selected system names |
mResult | mapping where result shall be placed, 3 fields are available (keys are strings):
|
private void _AlarmScreenUNICOS_getFilterCompletions_domain | ( | const dyn_string & | dsSelectedSystems, |
mapping & | mResult | ||
) |
Get completions for filter on device domain
dsSelectedSystems | The list of selected system names |
mResult | mapping where result shall be placed, 3 fields are available (keys are strings):
|
private void _AlarmScreenUNICOS_getFilterCompletions_nature | ( | const dyn_string & | dsSelectedSystems, |
mapping & | mResult | ||
) |
Get completions for filter on device nature
dsSelectedSystems | The list of selected system names |
mResult | mapping where result shall be placed, 3 fields are available (keys are strings):
|
private void _AlarmScreenUNICOS_getSubSystemFromFile | ( | string | sSystemName, |
int | iSubSysIndex, | ||
dyn_string & | dsResult, | ||
string | sFileNameSuffix = "_unTreeDeviceOverview_subSystem.dat" |
||
) |
Read from configuration file This is a bit simplified version of original function _unTreeDeviceOverview_getSubSystemFromFile()
sSystemName | System name being processed |
iSubSysIndex | Which of 'subsystems' is required (1 = doman, 2 = nature) |
dsResult | Variable where resulting names will be placed |
sFileNameSuffix | Constant part of file name |
private dyn_string _AlarmScreenUNICOS_buildMenu | ( | const mapping & | mSource, |
const mapping & | mAlarmData, | ||
int | iMode | ||
) |
Build popup menu for right mouse button event in alarm table. The functionality is copied from unAlarmScreen_treatRightClickAnswer() function, with adaptation for new alarm screen.
mSource | Parameters of event in the table |
mAlarmData | All properties of selected alarm(s) in table |
iMode | The mode of data source for AS EWO, one of constants AS_NG_EWO_MODE_xxx |
private void _AlarmScreenUNICOS_extendBaseDpeMenu | ( | string | sAlias, |
dyn_string & | dsMenuList, | ||
int | iMode | ||
) |
The basic popup menu was built (or not) for selected DP, this function adds to that menu description items which are always there for any device in alarm screen.
sAlias | Alias for DP in activated row of alarm table |
dsMenuList | Previously built description of popup menu, can be empty |
iMode | The mode of data source for AS EWO, one of constants AS_NG_EWO_MODE_xxx |
private dyn_string _AlarmScreenUNICOS_buildColumnSubMenu | ( | const mapping & | mSource | ) |
Build items of submenu for showing/hiding table columns
mSource | Parameters of event in the table & |
private void _AlarmScreenUNICOS_buildFinalMenu | ( | dyn_string & | dsMenuList, |
const dyn_string & | dsColumnsMenu, | ||
int | iMode, | ||
bool | bDpeExists | ||
) |
Build the ultimate content of pupup menu.
dsMenuList | Preliminary popup menu description |
dsColumnsMenu | Items of 'View' submenu (show/hide table columns) |
iMode | The mode of data source for AS EWO, one of constants AS_NG_EWO_MODE_xxx |
bDpeExists | true if menu is being built for existing DPE |
private void _AlarmScreenUNICOS_enableDisableAckMenu | ( | const mapping & | mSource, |
const mapping & | mAlarmData, | ||
dyn_string & | dsMenuList, | ||
int | iMode | ||
) |
Enable/disable menu items of popup menu, related to alarm acknowledgment/masking TODO: the first part of logic is not clear at all, see comments inside this functions
mSource | Parameters of event in the table |
mAlarmData | All properties of selected alarm(s) in table |
dsMenuList | (partially) prepared description of popup menu |
iMode | The mode of data source for AS EWO, one of constants AS_NG_EWO_MODE_xxx |
private void _AlarmScreenUNICOS_disableMenuItem | ( | dyn_string & | dsMenuList, |
const string & | sItemType, | ||
const string & | sItemLabel | ||
) |
Disable item in popup menu description, i.e. the very last part shall be ",0" instead of ",1"
dsMenuList | Description of popup menu |
sItemType | The type of item to be disabled, typically "PUSH_BUTTON" |
PUSH_BUTTON | The label of item to be disabled |
private void _AlarmScreenUNICOS_menuCpcGenericAction | ( | const mapping & | mSource, |
const mapping & | mAlarmData, | ||
const dyn_string & | dsMenu, | ||
int | iAnswer | ||
) |
Process user selection from popup menu on alarm table. It was checked before calling this function that user selection is not one of alarm-specific menu items. Thus, selection must be most probably one of items for CPC device. The logic of this function corresponds to unAlarmScreen_treatRightClickAnswer().
mSource | Parameters of event source (what row/column in table was clicked, mouse pointer position etc.) |
mAlarmData | Properties of all alarms, selected in the table |
dsMenu | The description of popup menu that was hown to user |
iAnswer | The ID of menu item, selected by user |
private bool _AlarmScreenUNICOS_menuAlarmSpecific | ( | const mapping & | mSource, |
const mapping & | mAlarmData, | ||
int | iAnswer | ||
) |
Process menu selection corresponding to one of alarm-specific menu items (in contrast to general popup menu for UNICOS devices).
mSource | Parameters of event in the table |
mAlarmData | All properties of selected alarm(s) in table |
dsMenu | iAnswer The ID of item selected from menu |
private bool _AlarmScreenUNICOS_menuLineToClipboard | ( | const mapping & | mSource, |
const mapping & | mAlarmData | ||
) |
Copy content of active table row to clipboard
mSource | Parameters of event in the table |
mAlarmData | All properties of selected alarm(s) in table |
private bool _AlarmScreenUNICOS_menuShowAllColumns | ( | const mapping & | mSource | ) |
Make visible all table columns
mSource | Parameters of event in the table |
private bool _AlarmScreenUNICOS_menuShowHideColumn | ( | const mapping & | mSource, |
int | iColumnIdx | ||
) |
Switch visibility of single column in table
mSource | Parameters of event in the table |
iColumnIdx | Table column index |
private bool _AlarmScreenUNICOS_menuDisplayAlarmDetails | ( | const mapping & | mSource, |
const mapping & | mAlarmData | ||
) |
Display details of alarm in selected row
mSource | Parameters of event in the table |
mAlarmData | All properties of selected alarm(s) in table |
private bool _AlarmScreenUNICOS_menuInsertComment | ( | const mapping & | mSource, |
const mapping & | mAlarmData | ||
) |
Set comment for alarm in selected row
mSource | Parameters of event in the table |
mAlarmData | All properties of selected alarm(s) in table |
private void _AlarmScreenUNICOS_ackMultiple | ( | dyn_mapping & | dmAlarms | ) |
Acknowledge (multiple) alarms, selected in AS EWO
dmAlarms | List of alarms data for alarms to be acknowledged |
private void _AlarmScreenUNICOS_defaultPanel | ( | string | sDeviceName, |
string | sDescription | ||
) |
The replacement of function _unAlarmScreen_defaultPanel().
Action for click on "S" column of the alarm screen.
sDeviceName | string input, The DPE of the clicked device. |
sDescription | string input, The description of the clicked device. |
Usage | Internal. |