unRecipe 9.1.0
|
Functions | |
unUnRcpClass_FaceplateStatusRegisterCB (string sDp, bool bSystemConnected) | |
unUnRcpClass_FaceplateStatusDisconnection () | |
unUnRcpClass_FaceplateConnect (string deviceName) | |
unUnRcpClass_FaceplateDisconnect (string deviceName) | |
unUnRcpClass_ButtonRegisterCB (string sDp, bool bSystemConnected) | |
unUnRcpClass_UserLoginGetButtonState (string deviceName, string sType, dyn_string &dsReturnData) | |
unUnRcpClass_ButtonSetState (string deviceName, string sDpType, dyn_string dsUserAccess, dyn_string dsData) | |
unUnRcpClass_ButtonDisconnection () | |
unUnRcpClass_ButtonUserAccess (string sDpName, string sDpType, dyn_string &dsAccess) | |
unUnRcpClass_ButtonAnimationCB (string sDpLock, bool bLocked, string sDpSelect, string sSelectedManager, string sDpState, string sState) | |
unUnRcpClass_WidgetRegisterCB (string sDp, bool bSystemConnected) | |
unUnRcpClass_WidgetDisconnection (string sWidgetType) | |
unUnRcpClass_WidgetConnect (string deviceName, string sFrontEnd) | |
unUnRcpClass_WidgetDisconnect (string deviceName, string sFrontEnd) | |
unUnRcpClass_WidgetCB (string sDpLocked, bool bLocked, string sDpSelectedManager, string sSelectedManager, string sDpState, string sState, string sDpFESystemIntegrityAlarmValue, int iFESystemIntegrityAlarmValue, string sDpFESystemIntegrityAlarmEnabled, bool bFESystemIntegrityAlarmEnabled) | |
unUnRcpClass_MenuConfiguration (string sDpName, string sDpType, dyn_string dsAccessOk, dyn_string &menuList) | |
unUnRcpClass_HandleMenu (string deviceName, string sDpType, dyn_string menuList, int iMenuAnswer) | |
unUnRcpClass_StateAnimation (bool bSystemConnected, string sWidgetType, int iFESystemIntegrityAlarmValue, bool bFESystemIntegrityAlarmEnabled) | |
unUnRcpClass_StateDisconnection (string sWidgetType) | |
UNICOS Copyright (C) CERN 2014 All rights reserved
unUnRcpClass.ctl This library contains the widget, faceplate, etc. functions of UnRcpClass.
unUnRcpClass_FaceplateStatusRegisterCB | ( | string | sDp, |
bool | bSystemConnected | ||
) |
faceplate DistributedControl callback of the faceplate status panel
sDp | input, the DistributedControl system name DP name |
bSystemConnected | input, the state of the system name |
unUnRcpClass_FaceplateStatusDisconnection | ( | ) |
set the faceplate when the device system is disconnected
unUnRcpClass_FaceplateConnect | ( | string | deviceName | ) |
dpConnect to the device data
deviceName | input, the device DP name |
unUnRcpClass_FaceplateDisconnect | ( | string | deviceName | ) |
dpDisconnect to the device data
deviceName | input, the device DP name |
unUnRcpClass_ButtonRegisterCB | ( | string | sDp, |
bool | bSystemConnected | ||
) |
Contextual button DistributedControl callback of the contextual device button panel
sDp | input, the DistributedControl system name DP name |
bSystemConnected | input, the state of the system name |
unUnRcpClass_UserLoginGetButtonState | ( | string | deviceName, |
string | sType, | ||
dyn_string & | dsReturnData | ||
) |
return the device data, this function is called when the user logs in and logs out
deviceName | input, the device DP name |
sType | input, the device type |
dsReturnData | output, the device data, [1] = lock state, [2] = lock by, [3] .. [6] device data |
unUnRcpClass_ButtonSetState | ( | string | deviceName, |
string | sDpType, | ||
dyn_string | dsUserAccess, | ||
dyn_string | dsData | ||
) |
Set the state of the contextual button of the device
deviceName | input, the device DP name |
sDpType | 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 |
unUnRcpClass_ButtonDisconnection | ( | ) |
set the state of the device action button when the device system is disconnected
unUnRcpClass_ButtonUserAccess | ( | string | sDpName, |
string | sDpType, | ||
dyn_string & | dsAccess | ||
) |
returns the list of allowed action on the device for a user logged in
sDpName | input, the device DP name |
sDpType | input, the device type |
dsAccess | input, list of allowed action on the device |
unUnRcpClass_ButtonAnimationCB | ( | string | sDpLock, |
bool | bLocked, | ||
string | sDpSelect, | ||
string | sSelectedManager, | ||
string | sDpState, | ||
string | sState | ||
) |
callback function on the device data
sDpLock | input, the lock DPE |
bLocked | input, selected lock state of the device |
sDpSelect | input, the select DPE |
sSelectedManager | input, user and Ui that selected the device |
sDpState | input, the datapoint of the recipe class state |
sState | input, value of the recipe class state |
unUnRcpClass_WidgetRegisterCB | ( | string | sDp, |
bool | bSystemConnected | ||
) |
widget DistributedControl callback
sDp | input, the DistributedControl system name DP name |
bSystemConnected | input, the state of the system name |
unUnRcpClass_WidgetDisconnection | ( | string | sWidgetType | ) |
set the widget when the system is disconnected
sWidgetType | input, the type of widget |
use the exec mechanism to allow multiple widget.
unUnRcpClass_WidgetConnect | ( | string | deviceName, |
string | sFrontEnd | ||
) |
dpConnect to the device data
deviceName | input, front-end device DP name |
sFrontEnd | input, front-end device name |
unUnRcpClass_WidgetDisconnect | ( | string | deviceName, |
string | sFrontEnd | ||
) |
dpDisconnect to the device data
deviceName | input, front-end device DP name |
sFrontEnd | input, front-end device name |
unUnRcpClass_WidgetCB | ( | string | sDpLocked, |
bool | bLocked, | ||
string | sDpSelectedManager, | ||
string | sSelectedManager, | ||
string | sDpState, | ||
string | sState, | ||
string | sDpFESystemIntegrityAlarmValue, | ||
int | iFESystemIntegrityAlarmValue, | ||
string | sDpFESystemIntegrityAlarmEnabled, | ||
bool | bFESystemIntegrityAlarmEnabled | ||
) |
callback function on the device data
sDpLocked | input, the lock DPE |
bLocked | input, the lock state |
sDpSelectedManager | input, the selected manager DPE |
sSelectedManager | input, the selected manager |
sDpState | input, the recipe instance state DPE |
sState | input, the recipe instance state value |
sDpFESystemIntegrityAlarmValue | input, front-end device system integrity alarm DPE |
iFESystemIntegrityAlarmValue | input, front-end device system integrity alarm value |
sDpFESystemIntegrityAlarmEnabled | input, front-end device system integrity enable DPE |
bFESystemIntegrityAlarmEnabled | input, front-end device system integrity enable value |
use the exec mechanism to allow multiple widget.
unUnRcpClass_MenuConfiguration | ( | string | sDpName, |
string | sDpType, | ||
dyn_string | dsAccessOk, | ||
dyn_string & | menuList | ||
) |
pop-up menu
sDpName | input, device DP name |
sDpType | input, device type |
dsAccessOk | input, the access control |
menuList | output, pop-up menu to show, dyn_string to be given to the popupMenu function |
unUnRcpClass_HandleMenu | ( | string | deviceName, |
string | sDpType, | ||
dyn_string | menuList, | ||
int | iMenuAnswer | ||
) |
handle the answer of the popup menu
deviceName | input, device DP name |
sDpType | input, device type |
menuList | input, the access control |
iMenuAnswer | input, selected menu value |
unUnRcpClass_StateAnimation | ( | bool | bSystemConnected, |
string | sWidgetType, | ||
int | iFESystemIntegrityAlarmValue, | ||
bool | bFESystemIntegrityAlarmEnabled | ||
) |
animate the device State widget !!!!! function trigger by exec call, $-param and variable of the widget cannot be used, all the necessary data must be given to the function. The use of global var (global keyword declaration) is allowed
bSystemConnected | input, connection state of the system, true=system connected/false=system not connected |
sWidgetType | input, the type of widget |
iFESystemIntegrityAlarmValue | input, front-end device system integrity alarm value |
bFESystemIntegrityAlarmEnabled | input, front-end device system integrity enable value |
!!!!!!! all parameters must be given: function launched by exec
unUnRcpClass_StateDisconnection | ( | string | sWidgetType | ) |
animate the the device State widget when the system is disconnected !!!!! function trigger by exec call, $-param and variable of the widget cannot be used, all the necessary data must be given to the function. The use of global var (global keyword declaration) is allowed
sWidgetType | input, the type of widget |