cpcDeprecated.ctl File Reference

Functions

void cpcConfigGenericFunctions_getPlcDpName (string sSystemName, string sPlcName, string &sPlcDpName, dyn_string &exceptionInfo)
void cpcGenericObject_ColorBoxDisable (string sShape)
 cpcGenericObject_selectDevice (string deviceName, string deviceType)
void cpcGenericObject_WidgetXC_Animation (bool bLocked, string sSelectedManager, bit32 bit32StsReg01, bool bStsReg01Invalid, string sDpPosOV, int iPosOV, bool bInvalidBody, bool bInvalidLetter, int iSystemIntegrityAlarmValue, bool bSystemIntegrityAlarmEnabled, string sEvtMask, int iMask, bool lookupForLabel)
 cpcRcpBuffers_StateAnimation (blob blobData, bool bSystemConnected, string sWidgetType, int iFESystemIntegrityAlarmValue, bool bFESystemIntegrityAlarmEnabled)
 cpcRcpBuffers_StateDisconnection (string sWidgetType)
 cpcRcpBuffers_WidgetCB (string sDpLocked, bool bLocked, string sDpSelectedManager, string sSelectedManager, string sDpFESystemIntegrityAlarmValue, int iFESystemIntegrityAlarmValue, string sDpFESystemIntegrityAlarmEnabled, bool bFESystemIntegrityAlarmEnabled)
 cpcRcpBuffers_WidgetConnect (string deviceName, string sFrontEnd)
 cpcRcpBuffers_WidgetDisconnect (string deviceName, string sFrontEnd)
 cpcRcpBuffers_WidgetDisconnection (string sWidgetType)
 cpcRcpBuffers_WidgetRegisterCB (string sDp, bool bSystemConnected)

Detailed Description

cpcDeprecated.ctl This library contains all the deprecated functions from unCPC.

Creation Date
22/06/2018
Author:
Marcin Bes (BE-ICS-FD)

Function Documentation

void cpcConfigGenericFunctions_getPlcDpName ( string  sSystemName,
string  sPlcName,
string &  sPlcDpName,
dyn_string &  exceptionInfo 
)

Returns the full name of the PLC data point. Checks that PLC name is not empty and that PLC dp exists inside DB.

Deprecated:
2018-06-22
Constraints
None
Usage
Public
PVSS managers
UI
Parameters:
sSystemName The name of the distributed system (can be empty if not set).
sPlcName The name of the plc.
sPlcDpName The full name of the plc dp.
exceptionInfo The list of exceptions.
void cpcGenericObject_ColorBoxDisable ( string  sShape  ) 

Disable colorbox

Deprecated:
2018-06-22
Todo:
move to the unFaceplate
Constraints
None
Usage
Public
PVSS managers
UI
Parameters:
sShape graphical object name
cpcGenericObject_selectDevice ( string  deviceName,
string  deviceType 
)

Cloned from UN_INFOS/unWidget_SelectArea.pnl TODO: move to unCore

Deprecated:
2018-06-22
Constraints
None
Usage
Public
PVSS managers
UI
void cpcGenericObject_WidgetXC_Animation ( bool  bLocked,
string  sSelectedManager,
bit32  bit32StsReg01,
bool  bStsReg01Invalid,
string  sDpPosOV,
int  iPosOV,
bool  bInvalidBody,
bool  bInvalidLetter,
int  iSystemIntegrityAlarmValue,
bool  bSystemIntegrityAlarmEnabled,
string  sEvtMask,
int  iMask,
bool  lookupForLabel 
)
cpcRcpBuffers_StateAnimation ( blob  blobData,
bool  bSystemConnected,
string  sWidgetType,
int  iFESystemIntegrityAlarmValue,
bool  bFESystemIntegrityAlarmEnabled 
)

animate the device State widget

Deprecated:
2018-06-26

!!!!! 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:
blobData input, device data
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

cpcRcpBuffers_StateDisconnection ( string  sWidgetType  ) 

animate the the device State widget when the system is disconnected

Deprecated:
2018-06-26

!!!!! 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:
sWidgetType input, the type of widget
cpcRcpBuffers_WidgetCB ( string  sDpLocked,
bool  bLocked,
string  sDpSelectedManager,
string  sSelectedManager,
string  sDpFESystemIntegrityAlarmValue,
int  iFESystemIntegrityAlarmValue,
string  sDpFESystemIntegrityAlarmEnabled,
bool  bFESystemIntegrityAlarmEnabled 
)

callback function on the device data

Deprecated:
2018-06-26
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
sDpLocked input, the lock DPE
bLocked input, the lock state
sDpSelectedManager input, the selected manager DPE
sSelectedManager input, the selected manager
sDp1 input, the DPE1
blobData input, device data
sDpInvalid input, the invalid DPE
bInvalid input, data validity
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.

cpcRcpBuffers_WidgetConnect ( string  deviceName,
string  sFrontEnd 
)

dpConnect to the device data

Deprecated:
2018-06-26
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
deviceName input, front-end device DP name
sFrontEnd input, front-end device name

References cpcRcpBuffers_WidgetDisconnection().

cpcRcpBuffers_WidgetDisconnect ( string  deviceName,
string  sFrontEnd 
)

dpDisconnect to the device data

Deprecated:
2018-06-26
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
deviceName input, front-end device DP name
sFrontEnd input, front-end device name
cpcRcpBuffers_WidgetDisconnection ( string  sWidgetType  ) 

set the widget when the system is disconnected

Deprecated:
2018-07-30
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
sWidgetType input, the type of widget

use the exec mechanism to allow multiple widget.

Referenced by cpcRcpBuffers_WidgetConnect().

cpcRcpBuffers_WidgetRegisterCB ( string  sDp,
bool  bSystemConnected 
)

widget DistributedControl callback

Deprecated:
2018-06-26
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

Generated on 11 Mar 2019 for unCPC6 by  doxygen 1.6.1