unRecipe 9.1.0
unUnRcpClass.ctl File Reference

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)
 

Detailed Description

UNICOS Copyright (C) CERN 2014 All rights reserved

unUnRcpClass.ctl This library contains the widget, faceplate, etc. functions of UnRcpClass.

Creation Date
06/06/2011
Modification History
04/10/2012: Ivan
  • New actions added to the contextual buttons.
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Author
Ivan Prieto Barreiro (EN-ICE)

Function Documentation

◆ unUnRcpClass_FaceplateStatusRegisterCB()

unUnRcpClass_FaceplateStatusRegisterCB ( string  sDp,
bool  bSystemConnected 
)

faceplate DistributedControl callback of the faceplate status panel

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sDpinput, the DistributedControl system name DP name
bSystemConnectedinput, the state of the system name
Reviewed:
2018-06-25 UNICOSFaceplate

◆ unUnRcpClass_FaceplateStatusDisconnection()

unUnRcpClass_FaceplateStatusDisconnection ( )

set the faceplate when the device system is disconnected

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL

◆ unUnRcpClass_FaceplateConnect()

unUnRcpClass_FaceplateConnect ( string  deviceName)

dpConnect to the device data

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
deviceNameinput, the device DP name

◆ unUnRcpClass_FaceplateDisconnect()

unUnRcpClass_FaceplateDisconnect ( string  deviceName)

dpDisconnect to the device data

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
deviceNameinput, the device DP name

◆ unUnRcpClass_ButtonRegisterCB()

unUnRcpClass_ButtonRegisterCB ( string  sDp,
bool  bSystemConnected 
)

Contextual button DistributedControl callback of the contextual device button panel

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sDpinput, the DistributedControl system name DP name
bSystemConnectedinput, the state of the system name
Reviewed:
2018-06-25 UNICOSDevice

◆ unUnRcpClass_UserLoginGetButtonState()

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

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
deviceNameinput, the device DP name
sTypeinput, the device type
dsReturnDataoutput, the device data, [1] = lock state, [2] = lock by, [3] .. [6] device data
Reviewed:
2018-06-25 UNICOSDevice

◆ unUnRcpClass_ButtonSetState()

unUnRcpClass_ButtonSetState ( string  deviceName,
string  sDpType,
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
sDpTypeinput, 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

◆ unUnRcpClass_ButtonDisconnection()

unUnRcpClass_ButtonDisconnection ( )

set the state of the device action button when the device system is disconnected

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL

◆ unUnRcpClass_ButtonUserAccess()

unUnRcpClass_ButtonUserAccess ( string  sDpName,
string  sDpType,
dyn_string &  dsAccess 
)

returns the list of allowed action on the device for a user logged in

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sDpNameinput, the device DP name
sDpTypeinput, the device type
dsAccessinput, list of allowed action on the device

◆ unUnRcpClass_ButtonAnimationCB()

unUnRcpClass_ButtonAnimationCB ( string  sDpLock,
bool  bLocked,
string  sDpSelect,
string  sSelectedManager,
string  sDpState,
string  sState 
)

callback function on the device data

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sDpLockinput, the lock DPE
bLockedinput, selected lock state of the device
sDpSelectinput, the select DPE
sSelectedManagerinput, user and Ui that selected the device
sDpStateinput, the datapoint of the recipe class state
sStateinput, value of the recipe class state
Reviewed:
2018-06-25 UNICOSDevice

◆ unUnRcpClass_WidgetRegisterCB()

unUnRcpClass_WidgetRegisterCB ( string  sDp,
bool  bSystemConnected 
)

widget DistributedControl callback

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sDpinput, the DistributedControl system name DP name
bSystemConnectedinput, the state of the system name
Reviewed:
2018-06-25 UNICOSWidget

◆ unUnRcpClass_WidgetDisconnection()

unUnRcpClass_WidgetDisconnection ( string  sWidgetType)

set the widget when the system is disconnected

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sWidgetTypeinput, the type of widget

use the exec mechanism to allow multiple widget.

◆ unUnRcpClass_WidgetConnect()

unUnRcpClass_WidgetConnect ( string  deviceName,
string  sFrontEnd 
)

dpConnect to the device data

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
deviceNameinput, front-end device DP name
sFrontEndinput, front-end device name

◆ unUnRcpClass_WidgetDisconnect()

unUnRcpClass_WidgetDisconnect ( string  deviceName,
string  sFrontEnd 
)

dpDisconnect to the device data

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
deviceNameinput, front-end device DP name
sFrontEndinput, front-end device name

◆ unUnRcpClass_WidgetCB()

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

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sDpLockedinput, the lock DPE
bLockedinput, the lock state
sDpSelectedManagerinput, the selected manager DPE
sSelectedManagerinput, the selected manager
sDpStateinput, the recipe instance state DPE
sStateinput, the recipe instance state value
sDpFESystemIntegrityAlarmValueinput, front-end device system integrity alarm DPE
iFESystemIntegrityAlarmValueinput, front-end device system integrity alarm value
sDpFESystemIntegrityAlarmEnabledinput, front-end device system integrity enable DPE
bFESystemIntegrityAlarmEnabledinput, front-end device system integrity enable value
Reviewed:
2018-06-25 UNICOSWidget

use the exec mechanism to allow multiple widget.

◆ unUnRcpClass_MenuConfiguration()

unUnRcpClass_MenuConfiguration ( string  sDpName,
string  sDpType,
dyn_string  dsAccessOk,
dyn_string &  menuList 
)

pop-up menu

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sDpNameinput, device DP name
sDpTypeinput, device type
dsAccessOkinput, the access control
menuListoutput, pop-up menu to show, dyn_string to be given to the popupMenu function
Reviewed:
2018-06-25 UNICOSWidget

◆ unUnRcpClass_HandleMenu()

unUnRcpClass_HandleMenu ( string  deviceName,
string  sDpType,
dyn_string  menuList,
int  iMenuAnswer 
)

handle the answer of the popup menu

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
deviceNameinput, device DP name
sDpTypeinput, device type
menuListinput, the access control
iMenuAnswerinput, selected menu value
Reviewed:
2018-06-25 UNICOSWidget

◆ unUnRcpClass_StateAnimation()

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

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
bSystemConnectedinput, connection state of the system, true=system connected/false=system not connected
sWidgetTypeinput, the type of widget
iFESystemIntegrityAlarmValueinput, front-end device system integrity alarm value
bFESystemIntegrityAlarmEnabledinput, front-end device system integrity enable value
Reviewed:
2018-06-25 UNICOSWidget

!!!!!!! all parameters must be given: function launched by exec

◆ unUnRcpClass_StateDisconnection()

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

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters
sWidgetTypeinput, the type of widget
Reviewed:
2018-06-25 UNICOSWidget