cpcController.ctl File Reference

Functions



 CPC_Controller_ObjectListGetValueTime (string deviceName, string deviceType, dyn_string &dsReturnData)
 CPC_Controller_MenuConfiguration (string deviceName, string dpType, dyn_string dsAccessOk, dyn_string &menuList)
 CPC_Controller_HandleMenu (string deviceName, string dpType, dyn_string menuList, int menuAnswer)
 CPC_Controller_WidgetInitStatics (string deviceName)
 CPC_Controller_WidgetDPEs (string deviceName, dyn_string &dpes)
 CPC_Controller_WidgetAnimation (dyn_string dpes, dyn_anytype values, string widgetType)
 CPC_Controller_WidgetDisconnection (string sWidgetType)
mapping CPC_Controller_ButtonConfig (string deviceName)
 CPC_Controller_ButtonDPEs (string deviceName, dyn_string &dpes)
 CPC_Controller_ButtonSetState (string deviceName, string dpType, dyn_string dsUserAccess, dyn_string dsData)
 CPC_Controller_FaceplateInitStatics (string deviceName)
 CPC_Controller_FaceplateDPEs (string deviceName, dyn_string &dpes)
 CPC_Controller_FaceplateStatusAnimationCB (dyn_string dpes, dyn_anytype values)
 CPC_Controller_setProperty (string sProperty, anytype aPropertyValue)
 _CPC_Controller_updateBargraph ()
 _CPC_Controller_initBargraph (string sStandAlone)

Detailed Description

cpcController.ctl This library contains the widget, faceplate, etc. functions of Controller.

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

CPC_Controller_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_Controller_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 _CPC_Controller_initBargraph(), and UN_CONFIG_CPC_CONTROLLER_SCALING_METHOD_KEY.

CPC_Controller_WidgetDPEs ( string  deviceName,
dyn_string &  dpes 
)

Returns the list of Controller 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_Controller_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_Controller_setProperty(), CPC_StsReg01_OUTPST, CPC_StsReg01_REGST, CPC_StsReg01_TRST, CPC_WIDGET_TEXT_INVALID, CPC_WIDGET_TEXT_OLD_DATA, CPC_WIDGET_TEXT_WARNING_ERROR, CPC_WIDGET_TEXT_WARNING_SIMU, cpcGenericObject_FormatValueWithUnit(), cpcGenericObject_SystemInvalid(), and cpcGenericObject_WidgetAnimation().

CPC_Controller_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.

References CPC_Controller_setProperty(), and cpcGenericObject_WidgetDisconnection().

mapping CPC_Controller_ButtonConfig ( string  deviceName  ) 

Return button configuration including access level

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL

References CPC_FACEPLATE_BUTTON_OUTPUTPOSITIONING_MODE.

CPC_Controller_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:
deviceName input, the name of device
dpes input, the list of dpes to connect
CPC_Controller_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 CPC_FACEPLATE_BUTTON_OUTPUTPOSITIONING_MODE, CPC_StsReg01_OUTPST, CPC_StsReg01_REGST, CPC_StsReg01_SOFTLDST, CPC_StsReg01_TRST, and cpcButton_setButtonState().

CPC_Controller_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 _CPC_Controller_initBargraph(), and UN_CONFIG_CPC_CONTROLLER_SCALING_METHOD_KEY.

CPC_Controller_FaceplateDPEs ( string  deviceName,
dyn_string &  dpes 
)

Returns the list of Controller 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_Controller_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 _CPC_Controller_updateBargraph(), CPC_Controller_setProperty(), and cpcGenericObject_animateMaskEvent().

CPC_Controller_setProperty ( string  sProperty,
anytype  aPropertyValue 
)

Purpose: Set the property value of PID panel

Parameters: None

Usage: External

PVSS manager usage: NG, NV

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

References _CPC_Controller_updateBargraph().

Referenced by CPC_Controller_FaceplateStatusAnimationCB(), CPC_Controller_WidgetAnimation(), and CPC_Controller_WidgetDisconnection().

_CPC_Controller_updateBargraph (  ) 

Purpose: Update the bargraph of PID panel

Parameters: None

Usage: Internal

PVSS manager usage: NG, NV

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

Referenced by CPC_Controller_FaceplateStatusAnimationCB(), and CPC_Controller_setProperty().

_CPC_Controller_initBargraph ( string  sStandAlone  ) 

Purpose: Init the bargraph of PID panel

Parameters: sStandAlone: string, input, TRUE for standalone mode, anything else for non standalone mode

Usage: Internal

PVSS manager usage: NG, NV

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

Referenced by CPC_Controller_FaceplateInitStatics(), and CPC_Controller_WidgetInitStatics().


Generated on 18 Jun 2018 for unCPC6 by  doxygen 1.6.1