libs/unLHCCircuit_CircuitWidget.ctl File Reference

Functions

LHCCircuit widget

This is a set of functions provided to manage LHCCircuit widget

void unLHCCircuit_CircuitWidget_RegisterCB (string sDp, bool bConnected, string sTreeDp, int iCommand, string sTreeDpSystem, string sSystemName)
bool unLHCCircuit_CircuitWidget_checkDpeList (mapping mdsDeviceDpe, string sCircuit, string sInterlockType)
bool unLHCCircuit_CircuitWidget_checkFGC (dyn_string dsDpe, string sCircuit, string sInterlockType)
bool unLHCCircuit_CircuitWidget_checkQPS (dyn_string dsDpe, string sCircuit, string sInterlockType, bool nQPS=FALSE)
bool unLHCCircuit_CircuitWidget_checkPIC (dyn_string dsDpe, string sCircuit, string sInterlockType)
void unLHCCircuit_CircuitWidget_noCircuit ()
void unLHCCircuit_CircuitWidget_setDisconnection ()
void unLHCCircuit_CircuitWidget_setWidgetAnimationColor (string sBodyColor, string sWarningText, bool bSuperLock=false)
void unLHCCircuit_CircuitWidget_dpDisConnect ()
 unLHCCircuit_CircuitWidget_CIPC_SuperLockCB (dyn_string dsDPE, dyn_dyn_string ddsComment)
void unLHCCircuit_CircuitWidget_dpConnect (mapping mdsDeviceDpe, mapping mDQGROUPId, int iFGC_MASK)
 unLHCCircuit_CircuitWidget_CIPC_getSuperLock (dyn_string dsDPE)
void unLHCCircuit_CircuitWidget_CB (dyn_string dsDpe, dyn_dyn_int diValue)
bool unLHCCircuit_CircuitWidget_CBCheckDQGROUPContent (string sDQGROUP, dyn_int diValue)
void unLHCCircuit_CircuitWidget_setWidgetState ()
bool unLHCCircuit_CircuitWidget_checkSystemList (string sCircuit, string sCircuitInterlockType)
bool unLHCCircuit_CircuitWidget_GetDpe (mapping mDeviceDp, mapping mDeviceType, mapping &mdsDeviceDpe, int &iFGC_MASK)
bool unLHCCircuit_CircuitWidget_GetDpeSystem (dyn_string dsCircuitDeviceDp, dyn_string dsDeviceType, dyn_string &dsCircuitDeviceDpe, int &iFGC_MASK)
void unLHCCircuit_CircuitWidget_ReOrganiseDevice (string sCircuit, dyn_string &dsCircuitDeviceDp, dyn_string &dsCircuitDeviceAlias, dyn_string &dsCircuitDeviceType, mapping &mDeviceIdentifier, mapping &mDeviceType, mapping &mDQGROUPId)
void unLHCCircuit_CircuitWidget_addIdInDQGROUP (mapping &mId, string sDQGROUP, string sDeviceDp)
bool unLHCCircuit_CircuitWidget_allowedDeviceType (string sCircuitDeviceType, bool &bQPS)
void unLHCCircuit_CircuitWidget_addInMapping (mapping &m, string sId, string sKey)

Detailed Description

Authors:
: Herve Milcent AB/CO-IS
Date:
: 25/04/2008
Modification History
26/04/2011: Herve
  • CIR-23: Powering sub-sector and circuit widget: use PIC superlock for the animation

01/01/2011: Herve


Function Documentation

void unLHCCircuit_CircuitWidget_addIdInDQGROUP ( mapping &  mId,
string  sDQGROUP,
string  sDeviceDp 
)

Purpose: Remove all the QPS device and add the appropriate DQGROUP

Parameters:
mId,:dyn_string, output: add the sDeviceDp ID in the DQGROUP
sDQGROUP,:dyn_string, input: the DQGROUP
sDeviceDp,:input, output: the device dp

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

void unLHCCircuit_CircuitWidget_addInMapping ( mapping &  m,
string  sId,
string  sKey 
)

Purpose: Add sId for the sKey of the mapping m

Parameters:
m,:mapping, output: the mapping
sId,:string, input: the data to add
sKey,:string, input: the key

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

bool unLHCCircuit_CircuitWidget_allowedDeviceType ( string  sCircuitDeviceType,
bool &  bQPS 
)

Purpose: Check if the device is allowed and if of type QPS

Parameters:
sCircuitDeviceType,:string, input: the device type
bQPS,:bool, output: true=QPS device/false if not QPS device

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

void unLHCCircuit_CircuitWidget_CB ( dyn_string  dsDpe,
dyn_dyn_int  diValue 
)

Purpose: call back function, evaluate the content and animate the widget

Parameters:
dsDpe,:dyn_string, input: list of DPE
diValue,:dyn_dyn_int, input: list value

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

bool unLHCCircuit_CircuitWidget_CBCheckDQGROUPContent ( string  sDQGROUP,
dyn_int  diValue 
)

Purpose: If the DPe value of the DQGROUP contains one Id of the list of device associated to the circuit --> bad

Parameters:
sDQGROUP,:string, input: the DQGROUP
diValue,:dyn_int, input: the DQGROUP value

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

bool unLHCCircuit_CircuitWidget_checkDpeList ( mapping  mdsDeviceDpe,
string  sCircuit,
string  sInterlockType 
)

Purpose: Check the DPEList

Parameters:
mdsDeviceDpe,:mapping, input: list of DPE/system
sCircuit,:string, input: the circuit
sInterlockType,:string, input: the interlock type

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

bool unLHCCircuit_CircuitWidget_checkFGC ( dyn_string  dsDpe,
string  sCircuit,
string  sInterlockType 
)

Purpose: Check the DPE List for the FGC

Parameters:
dsDpe,:dyn_string, input: list of DPE
sCircuit,:string, input: the circuit
sInterlockType,:string, input: the interlock type

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

bool unLHCCircuit_CircuitWidget_checkPIC ( dyn_string  dsDpe,
string  sCircuit,
string  sInterlockType 
)

Purpose: Check the DPE List for the FGC

Parameters:
dsDpe,:dyn_string, input: list of DPE
sCircuit,:string, input: the circuit
sInterlockType,:string, input: the interlock type

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

bool unLHCCircuit_CircuitWidget_checkQPS ( dyn_string  dsDpe,
string  sCircuit,
string  sInterlockType,
bool  nQPS = FALSE 
)

Purpose: Check the DPE List for the FGC

Parameters:
dsDpe,:dyn_string, input: list of DPE
sCircuit,:string, input: the circuit
sInterlockType,:string, input: the interlock type

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

bool unLHCCircuit_CircuitWidget_checkSystemList ( string  sCircuit,
string  sCircuitInterlockType 
)

Check if the number of system is correct

Constraints
None
Usage
Public
PVSS managers
Ui
Parameters:
sCircuitinput, the circuit name
sCircuitInterlockTypeinput, the interlock type of the circuit
Returns:
true=OK/false=BAD
unLHCCircuit_CircuitWidget_CIPC_getSuperLock ( dyn_string  dsDPE)

Set the CIPC device name (g_dsCircuitCIPC) for the circuit Superlock state

Constraints
None
Usage
Public
PVSS managers
Ui
Parameters:
dsDPEinput, list of DPE
unLHCCircuit_CircuitWidget_CIPC_SuperLockCB ( dyn_string  dsDPE,
dyn_dyn_string  ddsComment 
)

Superlock CB

Constraints
None
Usage
Public
PVSS managers
Ui
Parameters:
dsDPEinput, list of DPE
ddsCommentinput, list of device log
void unLHCCircuit_CircuitWidget_dpConnect ( mapping  mdsDeviceDpe,
mapping  mDQGROUPId,
int  iFGC_MASK 
)

Purpose: Do the dpConnect

Parameters:
mdsDeviceDpe,:mapping, input: list of DPE
mDQGROUPId,:mapping, input: list of QPS id per DQGROUP involded in the circuit
iFGC_MASK,:int, input: FGC mask

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

void unLHCCircuit_CircuitWidget_dpDisConnect ( )

Purpose: Do the dpDisconnect

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

bool unLHCCircuit_CircuitWidget_GetDpe ( mapping  mDeviceDp,
mapping  mDeviceType,
mapping &  mdsDeviceDpe,
int &  iFGC_MASK 
)

Purpose: Get all the device DPE involded in the circuit and the FGC mask

Parameters:
mDeviceDp,:mapping, input: List of device DP per system
mDeviceType,:mapping, input: List of device type per system
mdsDeviceDpe,:mapping, output: List of device DPE per system
iFGC_MASK,:int, output: FGC mask

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

bool unLHCCircuit_CircuitWidget_GetDpeSystem ( dyn_string  dsCircuitDeviceDp,
dyn_string  dsDeviceType,
dyn_string &  dsCircuitDeviceDpe,
int &  iFGC_MASK 
)

Purpose: Get for one system the device DPE involded in the circuit and the FGC mask

Parameters:
dsCircuitDeviceDp,:dyn_string, input: List of device DP
dsDeviceType,:dyn_string, input: List of device type
dsCircuitDeviceDpe,:dyn_string, output: List of device DPE
iFGC_MASK,:int, output: FGC mask

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

void unLHCCircuit_CircuitWidget_noCircuit ( )

Purpose: set the widget animation when the circuit is unknown

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

void unLHCCircuit_CircuitWidget_RegisterCB ( string  sDp,
bool  bConnected,
string  sTreeDp,
int  iCommand,
string  sTreeDpSystem,
string  sSystemName 
)

Purpose: Register function used with the unTreeDeviceOverview_distributedRegister

Parameters:
sDp,:string, input: the bConnected Dp
bConnected,:bool, input: the state of the system
sTreeDp,:string, input: the internal tree command Dp
iCommand,:int, input: the command=DEVUN_ADD_COMMAND/DEVUN_DELETE_COMMAND/DEVUN_APPLY_FILTER
sTreeDpSystem,:string, input: the internal tree system Dp
sSystemName,:string, input: the system name/"" associated with the command

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

void unLHCCircuit_CircuitWidget_ReOrganiseDevice ( string  sCircuit,
dyn_string &  dsCircuitDeviceDp,
dyn_string &  dsCircuitDeviceAlias,
dyn_string &  dsCircuitDeviceType,
mapping &  mDeviceIdentifier,
mapping &  mDeviceType,
mapping &  mDQGROUPId 
)

Purpose: Remove all the QPS device and add the appropriate DQGROUP

Parameters:
sCircuit,:string, intput: the circuit
dsCircuitDeviceDp,:dyn_string, output: List of device DP
dsCircuitDeviceAlias,:dyn_string, output: List of device DP
dsCircuitDeviceType,:dyn_string, output: List of device type
mDeviceIdentifier,:mapping, output: list of device identifer per system
mDeviceType,:mapping, output: list of device type per system
mDQGROUPId,:mapping, output: list of QPS device ID per DQGROUP

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

void unLHCCircuit_CircuitWidget_setDisconnection ( )

Purpose: set the widget animation when at least one system of the circuit is not connected

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

void unLHCCircuit_CircuitWidget_setWidgetAnimationColor ( string  sBodyColor,
string  sWarningText,
bool  bSuperLock = false 
)

Purpose: Animate the circuit widget color

Parameters:
sBodyColor,:string, input: body color
sWarningText,:string, input: warning text
bSuperLock,:bool, input, superlock state: true=superlock ON/false=superlock false (default)

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

void unLHCCircuit_CircuitWidget_setWidgetState ( )

Purpose: Set the widget state bodycolor and warningtext

Usage: Public

PVSS manager usage: PVSS00ui

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00ui . operating system: WXP, Linux. . distributed system: yes.

 All Files Functions