cpcAnalogInput.ctl File Reference

Functions



 CPC_AnalogInput_AcknowledgeAlarm (string deviceName, string dpType, dyn_string &dsNeedAck)
 CPC_AnalogInput_ObjectListGetValueTime (string deviceName, string deviceType, dyn_string &dsReturnData)
 CPC_AnalogInput_MenuConfiguration (string deviceName, string dpType, dyn_string dsAccessOk, dyn_string &menuList)
 CPC_AnalogInput_HandleMenu (string deviceName, string dpType, dyn_string menuList, int menuAnswer)
 CPC_AnalogInput_WidgetRegisterCB (string sDp, bool bSystemConnected)
 CPC_AnalogInput_WidgetInitStatics (string deviceName)
 CPC_AnalogInput_WidgetLockDPEs (string deviceName, dyn_string &dpes)
 CPC_AnalogInput_WidgetDPEs (string deviceName, dyn_string &dpes)
 CPC_AnalogInput_WidgetAnimation (dyn_string dpes, dyn_anytype values, string widgetType)
 CPC_AnalogInput_WidgetDisconnection (string sWidgetType)
mapping CPC_AnalogInput_ButtonConfig (string deviceName)
 CPC_AnalogInput_ButtonDPEs (string deviceName, dyn_string &dpes)
 CPC_AnalogInput_ButtonSetState (string deviceName, string dpType, dyn_string dsUserAccess, dyn_string dsData)
 CPC_AnalogInput_FaceplateInitStatics (string deviceName)
 CPC_AnalogInput_FaceplateLockDPEs (string deviceName, dyn_string &dpes)
 CPC_AnalogInput_FaceplateDPEs (string deviceName, dyn_string &dpes)
 CPC_AnalogInput_FaceplateStatusAnimationCB (dyn_string dpes, dyn_anytype values)

Detailed Description

cpcAnalogInput.ctl This library contains the widget, faceplate, etc. functions of AnalogInput.

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_AnalogInput_AcknowledgeAlarm ( string  deviceName,
string  dpType,
dyn_string &  dsNeedAck 
)

Returns the list of AnalogInput DPE with alarm config that can be acknowledged

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
deviceName input, device name DP name
dpType input, device type
dsNeedAck output, the lsit of DPE

Referenced by CPC_AnalogOutput_AcknowledgeAlarm().

CPC_AnalogInput_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

Referenced by CPC_AnalogOutput_ObjectListGetValueTime().

CPC_AnalogInput_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 CPC_POPUPMENU_MANUAL_IO_ERROR_BLOCK, cpcGenericObject_addDefaultUnicosActionToMenu(), cpcGenericObject_addTrendActionToMenu(), and cpcGenericObject_addUnicosActionToMenu().

Referenced by CPC_AnalogOutput_MenuConfiguration().

CPC_AnalogInput_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().

Referenced by CPC_AnalogOutput_HandleMenu().

CPC_AnalogInput_WidgetRegisterCB ( string  sDp,
bool  bSystemConnected 
)

widget register callback

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
sDp input, the DistributedControl system name DP name
bSystemConnected input, the state of the system name

References CPC_AnalogInput_WidgetDisconnection(), cpcGenericAnimation_WidgetConnect(), cpcGenericAnimation_WidgetDisconnect(), and cpcGenericAnimation_WidgetLockDPEs().

CPC_AnalogInput_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 cpcGenericObject_GetAnalogAlarmType().

Referenced by CPC_AnalogOutput_WidgetInitStatics().

CPC_AnalogInput_WidgetLockDPEs ( string  deviceName,
dyn_string &  dpes 
)

Returns the list of AnalogInput alert handler's locker dpes

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
deviceName input, the device name
dpes input/output, dpe list

Referenced by CPC_AnalogOutput_WidgetLockDPEs().

CPC_AnalogInput_WidgetDPEs ( string  deviceName,
dyn_string &  dpes 
)

Returns the list of AnalogInput 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

Referenced by CPC_AnalogOutput_WidgetDPEs().

CPC_AnalogInput_WidgetAnimation ( dyn_string  dpes,
dyn_anytype  values,
string  widgetType 
)
CPC_AnalogInput_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.

Referenced by CPC_AnalogInput_WidgetRegisterCB(), and CPC_AnalogOutput_WidgetDisconnection().

mapping CPC_AnalogInput_ButtonConfig ( string  deviceName  ) 

Return button configuration including access level

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL

References CPC_ACCESS_RIGHTS_EXPERT, CPC_ACCESS_RIGHTS_NOONE, CPC_ACCESS_RIGHTS_OPERATOR, and cpcExportGenericFunctions_get5AlertAcknowledgeAlarmValue().

Referenced by CPC_AnalogOutput_ButtonConfig().

CPC_AnalogInput_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

Referenced by CPC_AnalogOutput_ButtonDPEs().

CPC_AnalogInput_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 cpcButton_setButtonState(), and cpcGenericAnimation_ButtonList().

CPC_AnalogInput_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 cpcExportGenericFunctions_get5AlertAcknowledgeAlarmValue(), cpcGenericObject_GetAnalogAlarmType(), and cpcGenericObject_isAlarmWithMail().

Referenced by CPC_AnalogOutput_FaceplateInitStatics().

CPC_AnalogInput_FaceplateLockDPEs ( string  deviceName,
dyn_string &  dpes 
)

Returns the list of AnalogInput alert handler's locker dpes

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
deviceName input, the device name
dpes input/output, dpe list

Referenced by CPC_AnalogOutput_FaceplateLockDPEs().

CPC_AnalogInput_FaceplateDPEs ( string  deviceName,
dyn_string &  dpes 
)

Returns the list of AnalogInput 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

Referenced by CPC_AnalogOutput_FaceplateDPEs().

CPC_AnalogInput_FaceplateStatusAnimationCB ( dyn_string  dpes,
dyn_anytype  values 
)

Generated on 11 Jul 2013 for unCPC6 by  doxygen 1.6.1