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

Functions

 CPC_WordParameter_ObjectListGetValueTime (string deviceName, string deviceType, dyn_string &dsReturnData)
 
 CPC_WordParameter_MenuConfiguration (string deviceName, string dpType, dyn_string dsAccessOk, dyn_string &menuList)
 
 CPC_WordParameter_HandleMenu (string deviceName, string dpType, dyn_string menuList, int menuAnswer)
 
 CPC_WordParameter_WidgetInitStatics (string deviceName)
 
 CPC_WordParameter_WidgetDPEs (string deviceName, dyn_string &dpes)
 
 CPC_WordParameter_WidgetAnimation (dyn_string dpes, dyn_anytype values, string widgetType)
 
 CPC_WordParameter_WidgetDisconnection (string sWidgetType)
 
mapping CPC_WordParameter_ButtonConfig (string deviceName)
 
 CPC_WordParameter_ButtonSetState (string deviceName, string dpType, dyn_string dsUserAccess, dyn_string dsData)
 
 CPC_WordParameter_FaceplateInitStatics (string deviceName)
 
 CPC_WordParameter_FaceplateDPEs (string deviceName, dyn_string &dpes)
 
 CPC_WordParameter_FaceplateStatusAnimationCB (dyn_string dsDpes, dyn_anytype daValues)
 
string CPC_WordParameter_LookupLabel (mapping mLabels, string sIdx)
 
string CPC_WordParameter_GetBitText (int iValue)
 

Detailed Description

cpcWordParameter.ctl This library contains the widget, faceplate, etc. functions of WordParameter.

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

Function Documentation

◆ CPC_WordParameter_ObjectListGetValueTime()

CPC_WordParameter_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_WordParameter_MenuConfiguration()

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

◆ CPC_WordParameter_HandleMenu()

CPC_WordParameter_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_WordParameter_WidgetInitStatics()

CPC_WordParameter_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_WordParameter_WidgetDPEs()

CPC_WordParameter_WidgetDPEs ( string  deviceName,
dyn_string &  dpes 
)

Returns the list of WordParameter 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_WordParameter_WidgetAnimation()

CPC_WordParameter_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_WordParameter_GetBitText(), cpcGenericObject_FormatValueWithUnit(), and cpcGenericObject_WidgetValidnessAnimation().

◆ CPC_WordParameter_WidgetDisconnection()

CPC_WordParameter_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_WordParameter_ButtonConfig()

mapping CPC_WordParameter_ButtonConfig ( string  deviceName)

Return button configuration including access level

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL

References CPC_FACEPLATE_BUTTON_PARAMETER_SET_VALUE.

◆ CPC_WordParameter_ButtonSetState()

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

◆ CPC_WordParameter_FaceplateInitStatics()

CPC_WordParameter_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 cpcGenericDpFunctions_getMapping(), and cpcGenericObject_StringToMapping().

◆ CPC_WordParameter_FaceplateDPEs()

CPC_WordParameter_FaceplateDPEs ( string  deviceName,
dyn_string &  dpes 
)

Returns the list of WordParameter 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_WordParameter_FaceplateStatusAnimationCB()

CPC_WordParameter_FaceplateStatusAnimationCB ( dyn_string  dsDpes,
dyn_anytype  daValues 
)

callback function on the device data

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
dsDpesinput, the dpe names
daValuesinput, the dpe values

References cpcGenericObject_animateMaskEvent(), and cpcGenericObject_setStatusBitInvalidValue().

◆ CPC_WordParameter_LookupLabel()

string CPC_WordParameter_LookupLabel ( mapping  mLabels,
string  sIdx 
)

Function to get the value inside the labels mapping based on the index

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
mLabelslabels of the WPAR
sIdxindex of the label in use
Returns
Text of the given index

Referenced by CPC_WordParameter_GetBitText().

◆ CPC_WordParameter_GetBitText()

string CPC_WordParameter_GetBitText ( int  iValue)

Function to get the text based on the active bit(s) of the given value

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
iValuevalue to be converted to a text
Returns
Text of the given value

References CPC_WordParameter_LookupLabel().

Referenced by CPC_WordParameter_WidgetAnimation().