unCPC6  6.6.2
WinCC-OA implementation of UNICOS CPC
 All Files Functions Variables Pages
cpcAnalogAlarm.ctl File Reference

Functions

 CPC_AnalogAlarm_AcknowledgeAlarm (string deviceName, string dpType, dyn_string &dsNeedAck)
 
 CPC_AnalogAlarm_ObjectListGetValueTime (string deviceName, string deviceType, dyn_string &dsReturnData)
 
 CPC_AnalogAlarm_MenuConfiguration (string deviceName, string dpType, dyn_string dsAccessOk, dyn_string &menuList)
 
 CPC_AnalogAlarm_HandleMenu (string deviceName, string dpType, dyn_string menuList, int menuAnswer)
 
 CPC_AnalogAlarm_WidgetInitStatics (string deviceName)
 
 CPC_AnalogAlarm_WidgetDPEs (string deviceName, dyn_string &dpes)
 
 CPC_AnalogAlarm_WidgetAnimation (dyn_string dpes, dyn_anytype values, string widgetType)
 
 CPC_AnalogAlarm_WidgetDisconnection (string sWidgetType)
 
mapping CPC_AnalogAlarm_ButtonConfig (string deviceName)
 
 CPC_AnalogAlarm_ButtonDPEs (string deviceName, dyn_string &dpes)
 
 CPC_AnalogAlarm_ButtonSetState (string deviceName, string dpType, dyn_string dsUserAccess, dyn_string dsData)
 
 CPC_AnalogAlarm_FaceplateInitStatics (string deviceName)
 
 CPC_AnalogAlarm_FaceplateDPEs (string deviceName, dyn_string &dpes)
 
 CPC_AnalogAlarm_FaceplateStatusAnimationCB (dyn_string dpes, dyn_anytype values)
 

Detailed Description

cpcAnalogAlarm.ctl This library contains the widget, faceplate, etc. functions of AnalogAlarm.

Creation Date
dd/mm/yyyy
Modification History
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Author
the author (DEP-GROUP)

Function Documentation

CPC_AnalogAlarm_AcknowledgeAlarm ( string  deviceName,
string  dpType,
dyn_string &  dsNeedAck 
)
Returns the list of AnalogAlarm DPE with alarm config that can be acknowledged
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
deviceNameinput, device name DP name
dpTypeinput, device type
dsNeedAckoutput, the lsit of DPE
CPC_AnalogAlarm_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
deviceNameinput, device name
deviceTypeinput, device type
dsReturnDataoutput, return data, array of 5 strings
CPC_AnalogAlarm_MenuConfiguration ( string  deviceName,
string  dpType,
dyn_string  dsAccessOk,
dyn_string &  menuList 
)
pop-up menu
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
deviceNameinput, device DP name
dpTypeinput, device type
dsAccessOkinput, the access control
menuListoutput, pop-up menu to show, dyn_string to be given to the popupMenu function

References CPC_POPUPMENU_DIAG_INFO_TEXT, CPC_POPUPMENU_MASK_ALST_TEXT, cpcGenericObject_addDefaultUnicosActionToMenu(), and cpcGenericObject_addUnicosActionToMenu().

CPC_AnalogAlarm_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
deviceNameinput, device DP name
dpTypeinput, device type
menuListinput, the access control
menuAnswerinput, selected menu value

References cpcGenericObject_HandleUnicosMenu().

CPC_AnalogAlarm_WidgetInitStatics ( string  deviceName)
Init static values which are used in widget animation
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
deviceNameinput, the device name
CPC_AnalogAlarm_WidgetDPEs ( string  deviceName,
dyn_string &  dpes 
)
Returns the list of AnalogAlarm DPEs which should be connected on widget animation
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
deviceNameinput, the device name
dpesinput/output, dpe list
CPC_AnalogAlarm_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_AnalogAlarm_ButtonConfig ( string  deviceName)
Return button configuration including access level
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL

References CPC_FACEPLATE_BUTTON_SET_AA_LIMITS, and cpcExportGenericFunctions_getAcknowledgeAlarmValue().

CPC_AnalogAlarm_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
deviceNameinput, the name of device
dpesinput, the list of dpes to connect
CPC_AnalogAlarm_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
deviceNameinput, the device DP name
dpTypeinput, the device type
dsUserAccessinput, list of allowed action on the device
dsDatainput, the device data [1] = lock state, [2] = lock by, [3] .. [6] device data

References CPC_FACEPLATE_BUTTON_SET_AA_LIMITS, CPC_StsReg01_AUIHMBST, CPC_StsReg01_MALBRST, and cpcButton_setButtonState().

CPC_AnalogAlarm_FaceplateInitStatics ( string  deviceName)
Init static values which are used in faceplate animation
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
deviceNameinput, the device name

References CPC_CONFIG_TYPE_KEY, cpcExportGenericFunctions_getAcknowledgeAlarmValue(), cpcGenericDpFunctions_getDeviceProperty(), cpcGenericObject_DisplayText(), cpcGenericObject_isInMailSMS(), and cpcGenericObject_translateAlarmAcronym().

CPC_AnalogAlarm_FaceplateDPEs ( string  deviceName,
dyn_string &  dpes 
)
Returns the list of AnalogAlarm DPEs which should be connected on faceplate animation
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
deviceNameinput, the device name
dpesinput/output, dpe list
CPC_AnalogAlarm_FaceplateStatusAnimationCB ( dyn_string  dpes,
dyn_anytype  values 
)
callback function on the device data
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
dpesinput, the dpe names
valuesinput, the dpe values

References cpcGenericObject_animateMaskEvent(), and cpcGenericObject_CheckboxAnimate().