cpcDigitalAlarm.ctl File Reference
Functions |
|
|
| CPC_DigitalAlarm_AcknowledgeAlarm (string deviceName, string dpType, dyn_string &dsNeedAck) |
| CPC_DigitalAlarm_ObjectListGetValueTime (string deviceName, string deviceType, dyn_string &dsReturnData) |
| CPC_DigitalAlarm_MenuConfiguration (string deviceName, string dpType, dyn_string dsAccessOk, dyn_string &menuList) |
| CPC_DigitalAlarm_HandleMenu (string deviceName, string dpType, dyn_string menuList, int menuAnswer) |
| CPC_DigitalAlarm_WidgetInitStatics (string deviceName) |
| CPC_DigitalAlarm_WidgetDPEs (string deviceName, dyn_string &dpes) |
| CPC_DigitalAlarm_WidgetAnimation (dyn_string dpes, dyn_anytype values, string widgetType) |
| CPC_DigitalAlarm_WidgetDisconnection (string sWidgetType) |
mapping | CPC_DigitalAlarm_ButtonConfig (string deviceName) |
| CPC_DigitalAlarm_ButtonDPEs (string deviceName, dyn_string &dpes) |
| CPC_DigitalAlarm_ButtonSetState (string deviceName, string dpType, dyn_string dsUserAccess, dyn_string dsData) |
| CPC_DigitalAlarm_FaceplateInitStatics (string deviceName) |
| CPC_DigitalAlarm_FaceplateDPEs (string deviceName, dyn_string &dpes) |
| CPC_DigitalAlarm_FaceplateStatusAnimationCB (dyn_string dpes, dyn_anytype values) |
Detailed Description
cpcDigitalAlarm.ctl This library contains the widget, faceplate, etc. functions of DigitalAlarm.
- Creation Date
- dd/mm/yyyy
- Modification History
- Constraints
- None
- Usage
- Public
- PVSS managers
- Ui, CTRL
- Author:
- the author (DEP-GROUP)
©Copyright CERN 2013 - all rights reserved
Function Documentation
CPC_DigitalAlarm_AcknowledgeAlarm |
( |
string |
deviceName, |
|
|
string |
dpType, |
|
|
dyn_string & |
dsNeedAck | |
|
) |
| | |
Returns the list of DigitalAlarm DPE with alarm config that can be acknowledged
- Constraints
- None
- Usage
- Public
- PVSS managers
- Ui, CTRL
- Parameters:
-
| deviceName | input, device name DP name |
| dpType | input, device type |
| dsNeedAck | output, the lsit of DPE |
CPC_DigitalAlarm_ObjectListGetValueTime |
( |
string |
deviceName, |
|
|
string |
deviceType, |
|
|
dyn_string & |
dsReturnData | |
|
) |
| | |
Function called from snapshot utility of the treeDeviceOverview to get the time and value
- Constraints
- None
- Usage
- Public
- PVSS managers
- Ui, CTRL
- Parameters:
-
| deviceName | input, device name |
| deviceType | input, device type |
| dsReturnData | output, return data, array of 5 strings |
CPC_DigitalAlarm_MenuConfiguration |
( |
string |
deviceName, |
|
|
string |
dpType, |
|
|
dyn_string |
dsAccessOk, |
|
|
dyn_string & |
menuList | |
|
) |
| | |
CPC_DigitalAlarm_HandleMenu |
( |
string |
deviceName, |
|
|
string |
dpType, |
|
|
dyn_string |
menuList, |
|
|
int |
menuAnswer | |
|
) |
| | |
handle the answer of the popup menu
- Constraints
- None
- Usage
- Public
- PVSS managers
- Ui, CTRL
- Parameters:
-
| deviceName | input, device DP name |
| dpType | input, device type |
| menuList | input, the access control |
| menuAnswer | input, selected menu value |
References cpcGenericObject_HandleUnicosMenu().
CPC_DigitalAlarm_WidgetInitStatics |
( |
string |
deviceName |
) |
|
Init static values which are used in widget animation
- Constraints
- None
- Usage
- Public
- PVSS managers
- Ui, CTRL
- Parameters:
-
| deviceName | input, the device name |
CPC_DigitalAlarm_WidgetDPEs |
( |
string |
deviceName, |
|
|
dyn_string & |
dpes | |
|
) |
| | |
Returns the list of DigitalAlarm DPEs which should be connected on widget animation
- Constraints
- None
- Usage
- Public
- PVSS managers
- Ui, CTRL
- Parameters:
-
| deviceName | input, the device name |
| dpes | input/output, dpe list |
CPC_DigitalAlarm_WidgetAnimation |
( |
dyn_string |
dpes, |
|
|
dyn_anytype |
values, |
|
|
string |
widgetType | |
|
) |
| | |
callback function on the device data
- Constraints
- None
- Usage
- Public
- PVSS managers
- Ui, CTRL
- Parameters:
-
| dpes | input, the dpe names |
| values | input, the dpe values |
References CPC_StsReg01_CONFIGW, CPC_StsReg01_IST, CPC_StsReg01_MALBRST, CPC_StsReg01_POSW, CPC_WIDGET_ALARM, CPC_WIDGET_TEXT_ALARM_BLOCKED, CPC_WIDGET_TEXT_ALARM_MASKED, CPC_WIDGET_TEXT_CONFIGW, CPC_WIDGET_TEXT_POSW, CPC_WIDGET_TEXT_WARNING_ERROR, CPC_WIDGET_TEXT_WARNING_SIMU, and cpcGenericObject_WidgetValidnessAnimation().
CPC_DigitalAlarm_WidgetDisconnection |
( |
string |
sWidgetType |
) |
|
Disconnect function for the widget data
Parameters:
Usage: Internal
PVSS manager usage: NG, NV
Constraints: . Global variables defined in OnOff faceplate . PVSS version: 2.12.1 . operating system: NT and W2000, but tested only under W2000. . distributed system: yes.
- Reviewed:
- 2018-07-24 Callback
mapping CPC_DigitalAlarm_ButtonConfig |
( |
string |
deviceName |
) |
|
CPC_DigitalAlarm_ButtonDPEs |
( |
string |
deviceName, |
|
|
dyn_string & |
dpes | |
|
) |
| | |
Configure the list of dpes that needs for buttons animation
- Constraints
- None
- Usage
- Public
- PVSS managers
- Ui, CTRL
- Parameters:
-
| deviceName | input, the name of device |
| dpes | input, the list of dpes to connect |
CPC_DigitalAlarm_ButtonSetState |
( |
string |
deviceName, |
|
|
string |
dpType, |
|
|
dyn_string |
dsUserAccess, |
|
|
dyn_string |
dsData | |
|
) |
| | |
Set the state of the contextual button of the device
- Constraints
- None
- Usage
- Public
- PVSS managers
- Ui, CTRL
- Parameters:
-
| deviceName | input, the device DP name |
| dpType | input, the device type |
| dsUserAccess | input, list of allowed action on the device |
| dsData | input, the device data [1] = lock state, [2] = lock by, [3] .. [6] device data |
References CPC_FACEPLATE_BUTTON_SET_DA_MAIL_SMS, CPC_StsReg01_AUIHMBST, CPC_StsReg01_MALBRST, and cpcButton_setButtonState().
CPC_DigitalAlarm_FaceplateInitStatics |
( |
string |
deviceName |
) |
|
CPC_DigitalAlarm_FaceplateDPEs |
( |
string |
deviceName, |
|
|
dyn_string & |
dpes | |
|
) |
| | |
Returns the list of DigitalAlarm DPEs which should be connected on faceplate animation
- Constraints
- None
- Usage
- Public
- PVSS managers
- Ui, CTRL
- Parameters:
-
| deviceName | input, the device name |
| dpes | input/output, dpe list |
CPC_DigitalAlarm_FaceplateStatusAnimationCB |
( |
dyn_string |
dpes, |
|
|
dyn_anytype |
values | |
|
) |
| | |