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 deviceName)
 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)

©Copyright CERN 2013 - all rights reserved


Function Documentation

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:
deviceName input, device name
deviceType input, device type
dsReturnData output, return data, array of 5 strings

References CPC_AnalogStatus_ObjectListGetValueTime().

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:
deviceName input, device DP name
dpType input, device type
dsAccessOk input, the access control
menuList output, 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 ( 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_WordStatus_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

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

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:
deviceName input, the device name
dpes input/output, dpe list
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:
deviceName input, the device name
dpes input/output, dpe list
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:
dpes input, the dpe names
values input, 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 ( 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 cpcButton_setButtonState(), and cpcExportGenericFunctions_get5AlertAcknowledgeAlarmValue().

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.

CPC_WordStatus_FaceplateInitStatics ( string  deviceName  ) 

Init static values which are used in faceplate animation

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

References cpcGenericDpFunctions_getMapping(), and cpcGenericObject_StringToMapping().

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:
deviceName input, the device name
dpes input/output, dpe list
CPC_WordStatus_FaceplateStatusAnimationCB ( dyn_string  dpes,
dyn_anytype  values 
)

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 cpcGenericObject_WidgetValidnessAnimation().

CPC_WordStatus_FaceplateStatusDisconnection (  ) 

Faceplate disconnection function.

Normally you should not use this function.

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL

Generated on 18 Jun 2018 for unCPC6 by  doxygen 1.6.1