unCPC6 9.1.1
WinCC-OA implementation of UNICOS CPC
Loading...
Searching...
No Matches
cpcWordStatus.ctl File Reference

Functions

 CPC_WordStatus_ObjectListGetValueTime (string deviceName, string deviceType, dyn_string &dsReturnData)
 
 CPC_WordStatus_MenuConfiguration (string deviceName, string dpType, dyn_string dsAccessOk, dyn_string &menuList)
 
 CPC_WordStatus_AcknowledgeAlarm (string deviceName, string dpType, dyn_string &dsNeedAck)
 
 CPC_WordStatus_HandleMenu (string deviceName, string dpType, dyn_string menuList, int menuAnswer)
 
 CPC_WordStatus_WidgetInitStatics (string deviceName)
 
 CPC_WordStatus_WidgetLockDPEs (string deviceName, dyn_string &dpes)
 
 CPC_WordStatus_WidgetDPEs (string deviceName, dyn_string &dpes)
 
 CPC_WordStatus_WidgetAnimation (dyn_string dpes, dyn_anytype values, string widgetType)
 
mapping CPC_WordStatus_ButtonConfig (string deviceName)
 
 CPC_WordStatus_ButtonSetState (string deviceName, string dpType, dyn_string dsUserAccess, dyn_string dsData)
 
 CPC_WordStatus_WidgetDisconnection (string sWidgetType)
 
 CPC_WordStatus_FaceplateInitStatics (string sDeviceName)
 
 CPC_WordStatus_FaceplateDPEs (string deviceName, dyn_string &dpes)
 
 CPC_WordStatus_FaceplateStatusAnimationCB (dyn_string dpes, dyn_anytype values)
 
 CPC_WordStatus_FaceplateStatusDisconnection ()
 
string CPC_WordStatus_lookupLabel (mapping labels, string idx)
 

Detailed Description

cpcWordStatus.ctl This library contains the widget, faceplate, etc. functions of WordStatus.

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

Function Documentation

◆ CPC_WordStatus_ObjectListGetValueTime()

CPC_WordStatus_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

References CPC_AnalogStatus_ObjectListGetValueTime().

◆ CPC_WordStatus_MenuConfiguration()

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

◆ CPC_WordStatus_HandleMenu()

CPC_WordStatus_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_WordStatus_WidgetInitStatics()

CPC_WordStatus_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

References cpcGenericDpFunctions_getDeviceProperty(), cpcGenericDpFunctions_getMapping(), and cpcGenericObject_StringToMapping().

◆ CPC_WordStatus_WidgetLockDPEs()

CPC_WordStatus_WidgetLockDPEs ( string  deviceName,
dyn_string &  dpes 
)

Returns the list of WordStatus alert handler's locker dpes

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
deviceNameinput, the device name
dpesinput/output, dpe list

◆ CPC_WordStatus_WidgetDPEs()

CPC_WordStatus_WidgetDPEs ( string  deviceName,
dyn_string &  dpes 
)

Returns the list of WordStatus 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_WordStatus_WidgetAnimation()

CPC_WordStatus_WidgetAnimation ( dyn_string  dpes,
dyn_anytype  values,
string  widgetType 
)

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_TEXT_ALARM_ALST, CPC_WIDGET_TEXT_ALARM_DOES_NOT_EXIST, CPC_WIDGET_TEXT_ALARM_MASKED, and cpcGenericObject_WidgetValidnessAnimation().

◆ CPC_WordStatus_ButtonSetState()

CPC_WordStatus_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 cpcButton_setButtonState(), and cpcExportGenericFunctions_get5AlertAcknowledgeAlarmValue().

◆ CPC_WordStatus_WidgetDisconnection()

CPC_WordStatus_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_WordStatus_FaceplateInitStatics()

CPC_WordStatus_FaceplateInitStatics ( string  sDeviceName)

Init static values which are used in faceplate animation

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

References cpcGenericDpFunctions_getDeviceProperty(), cpcGenericDpFunctions_getMapping(), and cpcGenericObject_StringToMapping().

◆ CPC_WordStatus_FaceplateDPEs()

CPC_WordStatus_FaceplateDPEs ( string  deviceName,
dyn_string &  dpes 
)

Returns the list of WordStatus 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_WordStatus_FaceplateStatusAnimationCB()

CPC_WordStatus_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_WidgetValidnessAnimation().

◆ CPC_WordStatus_FaceplateStatusDisconnection()

CPC_WordStatus_FaceplateStatusDisconnection ( )

Faceplate disconnection function.

Normally you should not use this function.

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL