This library contains generic functions for device animation's routine. More...
This library contains generic functions for device animation's routine.
Those files generify routine of register/create/receive callback. The routine is implemented for widget, faceplate and buttons.
Basic structure:
©Copyright CERN 2013 - all rights reserved
dyn_string cpcGenericAnimation_WidgetDPEs | ( | string | deviceName, | |
string | frontEnd | |||
) |
Fetch widget DPEs from the device.
deviceName | device name | |
frontEnd | front-end name |
References cpcGenericAnimation_DevicePrefix().
Referenced by cpcGenericAnimation_WidgetConnect(), and cpcGenericAnimation_WidgetDisconnect().
dyn_string cpcGenericAnimation_WidgetLockDPEs | ( | string | deviceName | ) |
Fetch widget LockDPEs from the device.
deviceName | device name |
References cpcGenericAnimation_DevicePrefix().
Referenced by CPC_AnaDig_WidgetRegisterCB(), CPC_AnaDO_WidgetRegisterCB(), CPC_Analog_WidgetRegisterCB(), CPC_AnalogAlarm_WidgetRegisterCB(), CPC_AnalogInput_WidgetRegisterCB(), CPC_AnalogOutput_WidgetRegisterCB(), CPC_AnalogParameter_WidgetRegisterCB(), CPC_AnalogStatus_WidgetRegisterCB(), CPC_Controller_WidgetRegisterCB(), CPC_DigitalAlarm_WidgetRegisterCB(), CPC_DigitalInput_WidgetRegisterCB(), CPC_DigitalOutput_WidgetRegisterCB(), CPC_DigitalParameter_WidgetRegisterCB(), CPC_Local_WidgetRegisterCB(), CPC_MassFlowController_WidgetRegisterCB(), CPC_OnOff_WidgetRegisterCB(), CPC_ProcessControlObject_WidgetRegisterCB(), CPC_Word2AnalogStatus_WidgetRegisterCB(), CPC_WordParameter_WidgetRegisterCB(), CPC_WordStatus_WidgetRegisterCB(), and cpcGenericAnimation_WidgetRegisterCB().
void cpcGenericAnimation_WidgetRegisterCB | ( | string | sDp, | |
bool | bSystemConnected | |||
) |
widget register callback Does not work. Need to extend unGenericObject_WidgetInit to pass sDpType parameter. Otherwise impossible to call disconnection function if system is never being connected.
sDp | the DistributedControl system name DP name | |
bSystemConnected | the state of the system name |
References cpcGenericAnimation_WidgetConnect(), cpcGenericAnimation_WidgetDisconnect(), cpcGenericAnimation_WidgetDisconnection(), and cpcGenericAnimation_WidgetLockDPEs().
void cpcGenericAnimation_WidgetLockCallBack | ( | dyn_string | dpes, | |
dyn_bool | values | |||
) |
dpConnect to the alert handler's lock properties
dpes | lock names | |
values | lock values |
References cpcGenericAnimation_WidgetConnect(), cpcGenericAnimation_WidgetDisconnect(), and cpcGenericAnimation_WidgetDisconnection().
void cpcGenericAnimation_WidgetConnect | ( | string | deviceName, | |
string | frontEnd | |||
) |
Widget connect routine.
Init animation statics (with $DT$_WidgetInitStatics function) and does dpConnect for cpcGenericAnimation_WidgetDPEs.
deviceName | device name | |
frontEnd | front-end name |
References cpcGenericAnimation_DevicePrefix(), cpcGenericAnimation_WidgetDisconnection(), and cpcGenericAnimation_WidgetDPEs().
Referenced by CPC_AnaDig_WidgetRegisterCB(), CPC_AnaDO_WidgetRegisterCB(), CPC_Analog_WidgetRegisterCB(), CPC_AnalogAlarm_WidgetRegisterCB(), CPC_AnalogInput_WidgetRegisterCB(), CPC_AnalogOutput_WidgetRegisterCB(), CPC_AnalogParameter_WidgetRegisterCB(), CPC_AnalogStatus_WidgetRegisterCB(), CPC_Controller_WidgetRegisterCB(), CPC_DigitalAlarm_WidgetRegisterCB(), CPC_DigitalInput_WidgetRegisterCB(), CPC_DigitalOutput_WidgetRegisterCB(), CPC_DigitalParameter_WidgetRegisterCB(), CPC_Local_WidgetRegisterCB(), CPC_MassFlowController_WidgetRegisterCB(), CPC_OnOff_WidgetRegisterCB(), CPC_ProcessControlObject_WidgetRegisterCB(), CPC_Word2AnalogStatus_WidgetRegisterCB(), CPC_WordParameter_WidgetRegisterCB(), CPC_WordStatus_WidgetRegisterCB(), cpcGenericAnimation_WidgetLockCallBack(), and cpcGenericAnimation_WidgetRegisterCB().
void cpcGenericAnimation_WidgetDisconnect | ( | string | deviceName, | |
string | frontEnd | |||
) |
Widget disconnect routine.
deviceName | device name | |
frontEnd | front-end name |
References cpcGenericAnimation_WidgetDPEs().
Referenced by CPC_AnaDig_WidgetRegisterCB(), CPC_AnaDO_WidgetRegisterCB(), CPC_Analog_WidgetRegisterCB(), CPC_AnalogAlarm_WidgetRegisterCB(), CPC_AnalogInput_WidgetRegisterCB(), CPC_AnalogOutput_WidgetRegisterCB(), CPC_AnalogParameter_WidgetRegisterCB(), CPC_AnalogStatus_WidgetRegisterCB(), CPC_Controller_WidgetRegisterCB(), CPC_DigitalAlarm_WidgetRegisterCB(), CPC_DigitalInput_WidgetRegisterCB(), CPC_DigitalOutput_WidgetRegisterCB(), CPC_DigitalParameter_WidgetRegisterCB(), CPC_Local_WidgetRegisterCB(), CPC_MassFlowController_WidgetRegisterCB(), CPC_OnOff_WidgetRegisterCB(), CPC_ProcessControlObject_WidgetRegisterCB(), CPC_Word2AnalogStatus_WidgetRegisterCB(), CPC_WordParameter_WidgetRegisterCB(), CPC_WordStatus_WidgetRegisterCB(), cpcGenericAnimation_WidgetLockCallBack(), and cpcGenericAnimation_WidgetRegisterCB().
void cpcGenericAnimation_WidgetAnimationCB | ( | dyn_string | dpes, | |
dyn_anytype | values | |||
) |
Widget animation routine.
This functions is an animation callback. It tries to animate a widget with following function respection an order (if first exists, than just with first):
dpes | dpes names | |
values | dpes values |
References cpcGenericAnimation_DevicePrefix().
void cpcGenericAnimation_WidgetDisconnection | ( | string | deviceName | ) |
Widget disconnection routine.
update description
fix me!!!
References cpcGenericAnimation_DevicePrefix().
Referenced by cpcGenericAnimation_WidgetConnect(), cpcGenericAnimation_WidgetLockCallBack(), and cpcGenericAnimation_WidgetRegisterCB().
dyn_string cpcGenericAnimation_FaceplateDPEs | ( | string | deviceName, | |
string | frontEnd | |||
) |
Fetch faceplate DPEs from the device.
deviceName | device name | |
frontEnd | front-end name |
References cpcGenericAnimation_DevicePrefix().
Referenced by cpcGenericAnimation_FaceplateConnect(), and cpcGenericAnimation_FaceplateDisconnect().
dyn_string cpcGenericAnimation_FaceplateLockDPEs | ( | string | deviceName | ) |
Fetch faceplate LockDPEs from the device.
deviceName | device name |
References cpcGenericAnimation_DevicePrefix().
Referenced by cpcGenericAnimation_FaceplateStatusRegisterCB().
void cpcGenericAnimation_FaceplateStatusRegisterCB | ( | string | sDp, | |
bool | bSystemConnected | |||
) |
Faceplate register routine
Faceplate DistributedControl callback of the faceplate status panel.
sDp | the DistributedControl system name DP name | |
bSystemConnected | the state of the system name |
References cpcGenericAnimation_FaceplateConnect(), cpcGenericAnimation_FaceplateDisconnect(), cpcGenericAnimation_FaceplateLockDPEs(), and cpcGenericAnimation_FaceplateStatusDisconnection().
void cpcGenericAnimation_FaceplateLockCallBack | ( | dyn_string | dpes, | |
dyn_bool | values | |||
) |
Faceplate callback of the alert handler's lock properties
dpes | lock names | |
values | lock values |
References cpcGenericAnimation_FaceplateConnect(), cpcGenericAnimation_FaceplateDisconnect(), and cpcGenericAnimation_FaceplateStatusDisconnection().
void cpcGenericAnimation_FaceplateConnect | ( | string | deviceName | ) |
Faceplate connect routine.
Init animation statics (with $DT$_FaceplateInitStatics function) and does dpConnect for cpcGenericAnimation_FaceplateDPEs.
deviceName | device name |
References cpcGenericAnimation_DevicePrefix(), cpcGenericAnimation_FaceplateDPEs(), and cpcGenericAnimation_FaceplateStatusDisconnection().
Referenced by cpcGenericAnimation_FaceplateLockCallBack(), and cpcGenericAnimation_FaceplateStatusRegisterCB().
void cpcGenericAnimation_FaceplateStatusDisconnection | ( | ) |
Faceplate disconnection routine.
If device has $DT$_FaceplateStatusDisconnection that it will be triggered. Otherwise $DT$_FaceplateStatusAnimationCB will be called.
References cpcGenericAnimation_DevicePrefix().
Referenced by cpcGenericAnimation_FaceplateConnect(), cpcGenericAnimation_FaceplateLockCallBack(), and cpcGenericAnimation_FaceplateStatusRegisterCB().
void cpcGenericAnimation_FaceplateDisconnect | ( | string | deviceName | ) |
Faceplate disconnect routine.
DP disconnect FaceplateDPEs from $DT$_FaceplateStatusAnimationCB
deviceName | device name |
References cpcGenericAnimation_DevicePrefix(), and cpcGenericAnimation_FaceplateDPEs().
Referenced by cpcGenericAnimation_FaceplateLockCallBack(), and cpcGenericAnimation_FaceplateStatusRegisterCB().
dyn_string cpcGenericAnimation_ButtonDPEs | ( | string | deviceName | ) |
Fetch a list of dpe that need to be connected for button animation
Those DPEs should be defined in $DT$_ButtonDPEs function.
deviceName | the device name |
References cpcGenericAnimation_DevicePrefix().
Referenced by cpcGenericAnimation_ButtonRegisterCB().
mapping cpcGenericAnimation_ButtonConfig | ( | string | deviceName | ) |
Fetch a map of button properties for given device
This mapping is defined in $DT$_ButtonConfig function
deviceName | the device name |
References cpcGenericAnimation_DevicePrefix().
Referenced by cpcGenericAnimation_ButtonList(), and cpcGenericAnimation_ButtonUserAccess().
dyn_string cpcGenericAnimation_ButtonList | ( | string | deviceName | ) |
Return a list of button names for given device
This list is equals to keys of cpcGenericAnimation_ButtonConfig mapping
deviceName | the device name |
References cpcGenericAnimation_ButtonConfig().
Referenced by CPC_AnaDig_ButtonSetState(), CPC_AnaDO_ButtonSetState(), CPC_Analog_ButtonSetState(), CPC_AnalogAlarm_ButtonSetState(), CPC_AnalogInput_ButtonSetState(), CPC_AnalogOutput_ButtonSetState(), CPC_AnalogParameter_ButtonSetState(), CPC_Controller_ButtonSetState(), CPC_DigitalAlarm_ButtonSetState(), CPC_DigitalInput_ButtonSetState(), CPC_DigitalOutput_ButtonSetState(), CPC_DigitalParameter_ButtonSetState(), CPC_Local_ButtonSetState(), CPC_MassFlowController_ButtonSetState(), CPC_OnOff_ButtonSetState(), CPC_ProcessControlObject_ButtonSetState(), CPC_WordParameter_ButtonSetState(), and cpcGenericAnimation_ButtonDisconnection().
void cpcGenericAnimation_ButtonRegisterCB | ( | string | sDp, | |
bool | bSystemConnected | |||
) |
Button register routine
DistributedControl callback of the contextual device button panel.
sDp | the DistributedControl system name DP name | |
bSystemConnected | the state of the system name |
References cpcGenericAnimation_ButtonDisconnection(), and cpcGenericAnimation_ButtonDPEs().
void cpcGenericAnimation_ButtonAnimationCB | ( | dyn_string | dpes, | |
dyn_mixed | values | |||
) |
Button animation routine.
Triggers $DT$_ButtonSetState function.
dpes | dpes names | |
values | dpes values |
References cpcGenericAnimation_DevicePrefix().
void cpcGenericAnimation_ButtonDisconnection | ( | ) |
Button disconnection routine.
Proxy to cpcGenericObject_ButtonDisconnect
References cpcGenericAnimation_ButtonList(), and cpcGenericObject_ButtonDisconnect().
Referenced by cpcGenericAnimation_ButtonRegisterCB().
void cpcGenericAnimation_ButtonUserAccess | ( | string | sDpName, | |
string | sDpType, | |||
dyn_string & | dsAccess | |||
) |
Returns the list of allowed action on the device for a user logged in
sDpName | the device DP name | |
sDpType | the device type | |
dsAccess | list of allowed action on the device |
References CPC_ACCESS_RIGHTS_ADMIN, CPC_ACCESS_RIGHTS_EXPERT, CPC_ACCESS_RIGHTS_NOONE, CPC_ACCESS_RIGHTS_OPERATOR, and cpcGenericAnimation_ButtonConfig().
string cpcGenericAnimation_DevicePrefix | ( | string | deviceName | ) |
Returns the device prefix for given device.
deviceName | the device DP name |
Referenced by cpcGenericAnimation_ButtonAnimationCB(), cpcGenericAnimation_ButtonConfig(), cpcGenericAnimation_ButtonDPEs(), cpcGenericAnimation_FaceplateConnect(), cpcGenericAnimation_FaceplateDisconnect(), cpcGenericAnimation_FaceplateDPEs(), cpcGenericAnimation_FaceplateLockDPEs(), cpcGenericAnimation_FaceplateStatusDisconnection(), cpcGenericAnimation_WidgetAnimationCB(), cpcGenericAnimation_WidgetConnect(), cpcGenericAnimation_WidgetDisconnection(), cpcGenericAnimation_WidgetDPEs(), and cpcGenericAnimation_WidgetLockDPEs().