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

Functions

 CPC_ProcessControlObject_AcknowledgeAlarm (string deviceName, string dpType, dyn_string &dsNeedAck)
 
 CPC_ProcessControlObject_ObjectListGetValueTime (string deviceName, string deviceType, dyn_string &dsReturnData)
 
 CPC_ProcessControlObject_MenuConfiguration (string deviceName, string dpType, dyn_string dsAccessOk, dyn_string &menuList)
 
 CPC_ProcessControlObject_HandleMenu (string deviceName, string dpType, dyn_string menuList, int menuAnswer)
 
 CPC_ProcessControlObject_WidgetInitStatics (string deviceName)
 
 CPC_ProcessControlObject_WidgetDPEs (string deviceName, dyn_string &dpes)
 
 CPC_ProcessControlObject_WidgetAnimation (dyn_string dpes, dyn_anytype values, string widgetType)
 
 CPC_ProcessControlObject_WidgetDisconnection (string sWidgetType)
 
mapping CPC_ProcessControlObject_ButtonConfig (string deviceName)
 
 CPC_ProcessControlObject_ButtonDPEs (string deviceName, dyn_string &dpes)
 
 CPC_ProcessControlObject_ButtonSetState (string deviceName, string dpType, dyn_string dsUserAccess, dyn_string dsData)
 
 CPC_ProcessControlObject_FaceplateInitStatics (string deviceName)
 
 CPC_ProcessControlObject_FaceplateDPEs (string deviceName, dyn_string &dpes)
 
 CPC_ProcessControlObject_FaceplateStatusAnimationCB (dyn_string dpes, dyn_anytype values)
 
 CPC_ProcessControlObject_animateOptionMode (dyn_string dpes, dyn_string values, string dpeName, string color)
 
 CPC_ProcessControlObject_getOptionModesLabel (string sDpName, unsigned uLabel, string &result)
 
 CPC_ProcessControlObject_getOptionModesAllowance (string sDpName, unsigned uLabel, bit32 &result)
 
 CPC_ProcessControlObject_setOptionModes (string sDpName, dyn_string dsLabels, dyn_string dsAllowances, int &iRes)
 
 CPC_ProcessControlObject_getName (string sDpName, string &result)
 
 CPC_ProcessControlObject_setName (string sDpName, string name, dyn_string &exceptionInfo)
 
 unPCO_getNextAllowedModes (string sDpName, int iCurrentMode, bool bRunning, dyn_string &dsAllowedModes, dyn_string &exceptionInfo)
 
 unPCO_getOptionModesAllowance (string sDpName, unsigned uLabel, bit32 &result)
 
 unPCO_setOptionModes (string sDpName, dyn_string dsLabels, dyn_string dsAllowances, int &iRes)
 
 CPC_ProcessControlObject_getNextAllowedModes (string sDpName, int iCurrentMode, bool bRunning, dyn_string &dsAllowedModes, dyn_string &dsUnAllowedModes, dyn_string &exceptionInfo)
 
bool CPC_ProcessControlObject_isTopPCO (string dpName)
 

Detailed Description

cpcProcessControlObject.ctl This library contains the widget, faceplate, etc. functions of ProcessControlObject.

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

Function Documentation

CPC_ProcessControlObject_AcknowledgeAlarm ( string  deviceName,
string  dpType,
dyn_string &  dsNeedAck 
)
Returns the list of ProcessControlObject 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_ProcessControlObject_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_ProcessControlObject_getOptionModesLabel().

CPC_ProcessControlObject_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_ALARMS_TEXT, CPC_POPUPMENU_ALLOW_TO_RESTART_TEXT, CPC_POPUPMENU_RECIPES_TEXT, cpcGenericObject_addDefaultUnicosActionToMenu(), and cpcGenericObject_addUnicosActionToMenu().

CPC_ProcessControlObject_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_ProcessControlObject_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 CPC_ProcessControlObject_getName(), and cpcGenericDpFunctions_getDeviceProperty().

CPC_ProcessControlObject_WidgetDPEs ( string  deviceName,
dyn_string &  dpes 
)
Returns the list of ProcessControlObject 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_ProcessControlObject_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

References cpcGenericObject_WidgetDisconnection().

mapping CPC_ProcessControlObject_ButtonConfig ( string  deviceName)
Return button configuration including access level
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL

References CPC_FACEPLATE_BUTTON_ALLOW_RESTART.

CPC_ProcessControlObject_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_ProcessControlObject_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_ALLOW_RESTART, CPC_StsReg02_SOFTLDST, cpcButton_ButtonSetState(), and cpcButton_setButtonState().

CPC_ProcessControlObject_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_getDeviceProperty().

CPC_ProcessControlObject_FaceplateDPEs ( string  deviceName,
dyn_string &  dpes 
)
Returns the list of ProcessControlObject 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_ProcessControlObject_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 CPC_ProcessControlObject_animateOptionMode(), cpcGenericObject_animateMaskEvent(), and cpcGenericObject_animateNeedRestart().

CPC_ProcessControlObject_animateOptionMode ( dyn_string  dpes,
dyn_string  values,
string  dpeName,
string  color 
)

Animate option mode in faceplate.

Function is alike unFaceplate functions.

Constraints
None
Usage
Public
PVSS managers
UI
Parameters
dpesconnected dpe names
valuesconnected dpe values
dpeNamename of parameter to animate
colorfield color on valid state

References CPC_ProcessControlObject_getOptionModesLabel(), and cpcGenericObject_DisplayText().

Referenced by CPC_ProcessControlObject_FaceplateStatusAnimationCB().

CPC_ProcessControlObject_getOptionModesLabel ( string  sDpName,
unsigned  uLabel,
string &  result 
)

Purpose: this function is called by a PCO object to get an option mode label

Parameter: -> sDpName, string input, device name -> uLabel, unsigned input, label number -> result, string output, result of the function

Usage: Public

PVSS manager usage: Ctrl, NG, NV

Constraints: . PVSS version: 2.12.1 . operating system: NT and W2000, but tested only under W2000. . distributed system: yes.

Referenced by CPC_ProcessControlObject_animateOptionMode(), CPC_ProcessControlObject_ObjectListGetValueTime(), and CPC_ProcessControlObject_WidgetAnimation().

CPC_ProcessControlObject_getOptionModesAllowance ( string  sDpName,
unsigned  uLabel,
bit32 &  result 
)

Purpose: this function is called by a PCO object to get an option mode allowance

Parameter: -> sDpName, string input, device name -> uLabel, unsigned input, label number -> result, bit32 output, result of the function

Usage: Public

PVSS manager usage: Ctrl, NG, NV

Constraints: . PVSS version: 2.12.1 . operating system: NT and W2000, but tested only under W2000. . distributed system: yes.

CPC_ProcessControlObject_setOptionModes ( string  sDpName,
dyn_string  dsLabels,
dyn_string  dsAllowances,
int &  iRes 
)

Purpose: this function is called by a PCO object to set the option mode labels & allowance

Parameter: -> sDpName, string input, device name -> dsLabels, dyn_string input, labels -> dsAllowances, dyn_string input, allowances (must be bit32 variables converted to string) -> iRes, int output, result of the function, < 0 if an error occured

Usage: Public

PVSS manager usage: Ctrl, NG, NV

Constraints: . PVSS version: 2.12.1 . operating system: NT and W2000, but tested only under W2000. . distributed system: yes.

Referenced by CPC_ProcessControlObjectConfig_setCustomConfig().

CPC_ProcessControlObject_getName ( string  sDpName,
string &  result 
)

Purpose: this function is called by a PCO object to get PCO name

Parameter: -> sDpName, string input, device name -> result, string output, result of the function

Usage: Public

PVSS manager usage: Ctrl, NG, NV

Constraints: . PVSS version: 2.12.1 . operating system: NT and W2000, but tested only under W2000. . distributed system: yes.

References cpcGenericDpFunctions_getDeviceProperty().

Referenced by CPC_ProcessControlObject_WidgetInitStatics().

CPC_ProcessControlObject_setName ( string  sDpName,
string  name,
dyn_string &  exceptionInfo 
)

Purpose: this function is called by a PCO object to set the PCO name

Parameter: -> sDpName, string input, device name -> name, string input, name to be set -> exceptionInfo, dyn_string output, for errors

Usage: Public

PVSS manager usage: Ctrl, NG, NV

Constraints: . PVSS version: 2.12.1 . operating system: NT and W2000, but tested only under W2000. . distributed system: yes.

References cpcGenericDpFunctions_setDeviceProperty().

Referenced by CPC_ProcessControlObjectConfig_setCustomConfig().

CPC_ProcessControlObject_getNextAllowedModes ( string  sDpName,
int  iCurrentMode,
bool  bRunning,
dyn_string &  dsAllowedModes,
dyn_string &  dsUnAllowedModes,
dyn_string &  exceptionInfo 
)

Purpose: to get the modes you can access from current mode (using allowance tables)

Parameter: -> sDpName, string input, device name -> iCurrentMode, int input, current mode -> bRunning, bool input, true while running -> dsAllowedModes, dyn_string output, result of the function -> exceptionInfo, dyn_string output, for errors

Usage: Public

PVSS manager usage: Ctrl, NG, NV

Constraints: . PVSS version: 2.12.1 . operating system: NT and W2000, but tested only under W2000. . distributed system: yes.