unCPC6  6.6.11
WinCC-OA implementation of UNICOS CPC
cpcSumAlarm.ctl File Reference

Functions

void CPC_SumAlarm_AcknowledgeAlarm (string sDeviceName, string sDpType, dyn_string &dsNeedAck)
 
void CPC_SumAlarm_ObjectListGetValueTime (string sDeviceName, string sDeviceType, dyn_string &dsReturnData)
 
 CPC_SumAlarm_MenuConfiguration (string sDeviceName, string sDpType, dyn_string dsAccessOk, dyn_string &dsMenuList)
 
 CPC_SumAlarm_HandleMenu (string sDeviceName, string sDpType, dyn_string dsMenuList, int iMenuAnswer)
 
 CPC_SumAlarm_WidgetInitStatics (string sDeviceName)
 
void CPC_SumAlarm_WidgetDPEs (string sDeviceName, dyn_string &dsDpes)
 
 CPC_SumAlarm_WidgetAnimation (dyn_string dsDpes, dyn_anytype daValues, string sWidgetType)
 
void CPC_SumAlarm_WidgetDisconnection (string sWidgetType)
 
mapping CPC_SumAlarm_ButtonConfig (string sDeviceName)
 
void CPC_SumAlarm_ButtonDPEs (string sDeviceName, dyn_string &dsDpes)
 
void CPC_SumAlarm_ButtonSetState (string sDeviceName, string sDpType, dyn_string dsUserAccess, dyn_string dsData)
 
void CPC_SumAlarm_FaceplateInitStatics (string sDeviceName)
 
 CPC_SumAlarm_FaceplateDPEs (string sDeviceName, dyn_string &dsDpes)
 
 CPC_SumAlarm_FaceplateStatusAnimationCB (dyn_string dsDpes, dyn_anytype daValues)
 
void CPC_SumAlarm_WidgetLockDPEs (string sDeviceName, dyn_string &dsDpes)
 

Detailed Description

cpcSumAlarm.ctl This library contains the widget, faceplate, etc. functions of SummaryAlarm.

Creation Date
16/11/2020
Modification History
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Author
the author (DEP-GROUP) Jonas Arroyo (BE-ICS)

Function Documentation

◆ CPC_SumAlarm_AcknowledgeAlarm()

void CPC_SumAlarm_AcknowledgeAlarm ( string  sDeviceName,
string  sDpType,
dyn_string &  dsNeedAck 
)

Returns the list of Summary Alarm DPE with alarm config that can be acknowledged

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sDeviceName,string,input,devicename DP name
sDpType,string,input,devicetype
dsNeedAck,dyn_string,output,thelist of DPE

◆ CPC_SumAlarm_ObjectListGetValueTime()

void CPC_SumAlarm_ObjectListGetValueTime ( string  sDeviceName,
string  sDeviceType,
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
sDeviceName,string,input,devicename
sDeviceType,string,input,devicetype
dsReturnData,dyn_string,output,returndata, array of 5 strings

◆ CPC_SumAlarm_MenuConfiguration()

CPC_SumAlarm_MenuConfiguration ( string  sDeviceName,
string  sDpType,
dyn_string  dsAccessOk,
dyn_string &  dsMenuList 
)

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, cpcGenericObject_addDefaultUnicosActionToMenu(), and cpcGenericObject_addUnicosActionToMenu().

◆ CPC_SumAlarm_HandleMenu()

CPC_SumAlarm_HandleMenu ( string  sDeviceName,
string  sDpType,
dyn_string  dsMenuList,
int  iMenuAnswer 
)

handle the answer of the popup menu

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sDeviceName,string,input,deviceDP name
sDpType,string,input,devicetype
dsMenuList,dyn_string,input,theaccess control
iMenuAnswer,int,input,selectedmenu value

References cpcGenericObject_HandleUnicosMenu().

◆ CPC_SumAlarm_WidgetInitStatics()

CPC_SumAlarm_WidgetInitStatics ( string  sDeviceName)

Init static values which are used in widget animation

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sDeviceNameinput, the device name

◆ CPC_SumAlarm_WidgetDPEs()

void CPC_SumAlarm_WidgetDPEs ( string  sDeviceName,
dyn_string &  dsDpes 
)

Returns the list of DigitalAlarm 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_SumAlarm_WidgetAnimation()

CPC_SumAlarm_WidgetAnimation ( dyn_string  dsDpes,
dyn_anytype  daValues,
string  sWidgetType 
)

callback function on the device data

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
dpesinput, the dpe names
valuesinput, the dpe values

References CPC_WIDGET_ALARM, CPC_WIDGET_TEXT_ALARM_BLOCKED, CPC_WIDGET_TEXT_ALARM_MASKED, CPC_WIDGET_TEXT_POSW, and cpcGenericObject_WidgetValidnessAnimation().

◆ CPC_SumAlarm_WidgetDisconnection()

void CPC_SumAlarm_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

◆ CPC_SumAlarm_ButtonConfig()

mapping CPC_SumAlarm_ButtonConfig ( string  sDeviceName)

Return button configuration including access level

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL

◆ CPC_SumAlarm_ButtonDPEs()

void CPC_SumAlarm_ButtonDPEs ( string  sDeviceName,
dyn_string &  dsDpes 
)

Configure the list of dpes that needs for buttons animation

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sDeviceName,string,input,thename of device
dsDpes,dyn_string,input,thelist of dpes to connect

◆ CPC_SumAlarm_ButtonSetState()

void CPC_SumAlarm_ButtonSetState ( string  sDeviceName,
string  sDpType,
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
sDeviceName,string,input,thedevice DP name
sDpType,string,input,thedevice type
dsUserAccess,dyn_string,input,listof allowed action on the device
dsData,dyn_string,input,thedevice data [1] = lock state, [2] = lock by, [3] .. [6] device data

References cpcButton_setButtonState().

◆ CPC_SumAlarm_FaceplateInitStatics()

void CPC_SumAlarm_FaceplateInitStatics ( string  sDeviceName)

Init static values which are used in faceplate animation

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sDeviceNamestring, input, the device name

◆ CPC_SumAlarm_FaceplateDPEs()

CPC_SumAlarm_FaceplateDPEs ( string  sDeviceName,
dyn_string &  dsDpes 
)

Returns the list of DigitalAlarm DPEs which should be connected on faceplate animation

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sDeviceNamestring, input, the device name
dsDpes,dyn_string,output,dpelist

◆ CPC_SumAlarm_FaceplateStatusAnimationCB()

CPC_SumAlarm_FaceplateStatusAnimationCB ( dyn_string  dsDpes,
dyn_anytype  daValues 
)

callback function on the device data

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
dsDpesinput, dyn_string, The dpe names
daValuesinput, dyn_anytype, The dpe values

◆ CPC_SumAlarm_WidgetLockDPEs()

void CPC_SumAlarm_WidgetLockDPEs ( string  sDeviceName,
dyn_string &  dsDpes 
)

Returns the list of Summary Alarm alert handler's locker dpes

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sDeviceName,string,input,thedevice name
sDpes,dyn_string,output,dpelist