libs/unLHCCircuit_GenericFunctions.ctl File Reference

Functions

LHCCircuit Generic Functions

This is a set of generic functions provided to manage LHCCircuit

void unLHCCircuit_GenericFunctions_getSOCList (dyn_string &dsSOC)
void unLHCCircuit_GenericFunctions_getCircuitsFromSOC (anytype aSOC, anytype &aCircuits)
void unLHCCircuit_GenericFunctions_getDPEtoWidgetCB (dyn_string dsDeviceDpe, dyn_string dsFrontEndDp, dyn_string &dsParameters)
string unLHCCircuit_GenericFunctions_getCircuit (string sPoweringSubSector, string sFGCDp, string &sInterlockType)
bool unLHCCircuit_GenericFunctions_isDType_NotConnected (string sPoweringSubSector, string sCircuit, string sInterlockType, string sFGCDpe)
void unLHCCircuit_GenericFunctions_getDPEtoWidgetCB_Circuits (dyn_string dsDeviceDpe, dyn_string dsFrontEndDp, dyn_string &dsParameters)
void unLHCCircuit_GenericFunctions_widgetCB_Animation ()
bool unLHCCircuit_GenericFunctions_widgetCB_setPC_state ()
void unLHCCircuit_GenericFunctions_widgetCB_main ()
void unLHCCircuit_GenericFunctions_getPWSCircuit (string sPWS, dyn_string &dsCircuit)
void unLHCCircuit_GenericFunctions_getCircuitType (anytype aCircuit, anytype &aInterlockType, anytype &aCircuitType)
void unLHCCircuit_GenericFunctions_getCircuitDevice (dyn_string dsCircuit, dyn_dyn_string &ddsDeviceDp, dyn_dyn_string &ddsDeviceAlias, dyn_dyn_string &ddsDeviceType)
void unLHCCircuit_GenericFunctions_orderCircuitList (dyn_string &dsCircuit)
void unLHCCircuit_GenericFunctions_getSynopticName (const string sCircuit, const string sInterlockType, const string sDeviceType, string &sSymbol)
void unLHCCircuit_GenericFunctions_getSynopticDollarParameters (const string sInterlockType, const string sCircuitType, const string sCircuit, const dyn_string dsDpNames, const dyn_string dsAliases, const dyn_string dsDpTypes, string &sQPSType, dyn_string &dsQPS, dyn_string &dsPIC, dyn_string &dsPC, dyn_string &dsCBW, string &sCRYO, dyn_string &dsCircuitInfo)
void display_debug (const string sFilter, const string sText)
bool unLHCCircuit_GenericFunctions_widgetCB_checkParameters (const string sText, const int iNum)
bool unLHCCircuit_GenericFunctions_checkParametersPerInterlockType (const string sCircuit, const string sInterlockType, const int iLenQPS, const int iLenPIC, const int iLenPC)
void unLHCCircuit_GenericFunctions_sizeCircuitWidget ()
void unLHCCircuit_GenericFunctions_distributedRegister (const string sSystem, const string sIdentifier)
void unLHCCircuit_GenericFunctions_displayCircuits (const dyn_string dsWidgetFileNameList, const dyn_string dsInterlockType, const dyn_string dsCircuitType)
void unLHCCircuit_GenericFunctions_displaySynoptics (const string sCircuit, const string sInterlockType, const string sCircuitType, const int x, const int y, const int h)
 unLHCCircuit_GenericFunctions_checkAndCorrectDollarParam (string sInterlockType, string sCircuitType, string sCircuit, dyn_string &dsCBW)
void unLHCCircuit_GenericFunctions_addCircuit (const int iIndex, const string sWidgetFileNameList, const string sInterlockType, const string sCircuitType, const int iLeft, const int iTop)
bool unLHCCircuit_GenericFunctions_getDpNParameters (const int iCircuit, const string sCircuit, const string sInterlockType, dyn_string &dsDollars)
void unLHCCircuit_GenericFunctions_TreeDeviceOverviewWidgetRegisterCB (string sDp, bool bConnected, string sTreeDp, int iCommand, string sTreeDpSystem, string sSystemName)
dyn_string unLHCCircuit_buildDollarModule ()
void unLHCCircuit_getDollarModule (const string sCircuits, const string sInterlockTypes, const string sCircuitTypes, dyn_string &dsCircuits, dyn_string &dsInterlockTypes, dyn_string &dsCircuitTypes)
dyn_string unLHCCircuit_GenericFunctions_getSystemNameInvolved ()
void unLHCCircuit_GenericFunctions_WidgetRegister ()
string unLHCCircuit_GenericFunctions_getHTMLLink_DollarParam ()
void unLHCCircuit_GenericFunctions_CircuitModule (string sPanelFileName, const string sTitle, const dyn_string dsDollarParameters)
void unLHCCircuit_GenericFunctions_PWScloseSwitch (dyn_string dsDollarParameters, string sRef)
int unLHCCircuit_GenericFunctions_setDefaultUser ()
int unLHCCircuit_GenericFunctions_setFileAccess ()
 unLHC_Circuit_getDefaultMenuConfiguration (dyn_string &dsMenu)
 unLHC_Circuit_getDefaultFileAccessControl (dyn_string &dsFileAccess)

Detailed Description

Authors:
: Frederic BERNARD AB/CO-IS
Date:
: 01/12/2006

Modification History:

Authors:
: Frederic BERNARD AB/CO-IS
Date:
: 01/12/2006

Modification History:


Function Documentation

void display_debug ( const string  sFilter,
const string  sText 
)

display_debug

unLHC_Circuit_getDefaultFileAccessControl ( dyn_string &  dsFileAccess)

returns the file access control configuration

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
dsFileAccessoutput, return data, the file access control configuration
unLHC_Circuit_getDefaultMenuConfiguration ( dyn_string &  dsMenu)

returns the menu configuration

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
dsMenuoutput, return data, the menu definition
dyn_string unLHCCircuit_buildDollarModule ( )

buildDollarModule

void unLHCCircuit_GenericFunctions_addCircuit ( const int  iIndex,
const string  sWidgetFileNameList,
const string  sInterlockType,
const string  sCircuitType,
const int  iLeft,
const int  iTop 
)

GenericFunctions_addCircuit

unLHCCircuit_GenericFunctions_checkAndCorrectDollarParam ( string  sInterlockType,
string  sCircuitType,
string  sCircuit,
dyn_string &  dsCBW 
)

correct the $-param for the QPS DQROUP for RB, RQF and RQD circuit: QPS and nQPS DQGROUP are needed

Constraints
None
Usage
Public
PVSS managers
Ui
Parameters:
sInterlockTypeinput, the circuit interlock type
sCircuitTypeinput, the circuit type
sCircuitinput, the circuit
dsCBWoutput, the $-param
bool unLHCCircuit_GenericFunctions_checkParametersPerInterlockType ( const string  sCircuit,
const string  sInterlockType,
const int  iLenQPS,
const int  iLenPIC,
const int  iLenPC 
)

GenericFunctions_checkParametersPerInterlockType

void unLHCCircuit_GenericFunctions_CircuitModule ( string  sPanelFileName,
const string  sTitle,
const dyn_string  dsDollarParameters 
)

Purpose: special Behavior for LHC_CIRCUIT when opening a Module (from Circuit Widget)

Parameters:

  • dsDollarParameters: input, dyn_string, list of $-param
  • sPanelFileName: input, string, name of the reference panel
  • sTitle: input, string, name of circuit
void unLHCCircuit_GenericFunctions_displayCircuits ( const dyn_string  dsWidgetFileNameList,
const dyn_string  dsInterlockType,
const dyn_string  dsCircuitType 
)

GenericFunctions_displayCircuits

void unLHCCircuit_GenericFunctions_displaySynoptics ( const string  sCircuit,
const string  sInterlockType,
const string  sCircuitType,
const int  x,
const int  y,
const int  h 
)

GenericFunctions_displaySynoptics

void unLHCCircuit_GenericFunctions_distributedRegister ( const string  sSystem,
const string  sIdentifier 
)

GenericFunctions_distributedRegister

string unLHCCircuit_GenericFunctions_getCircuit ( string  sPoweringSubSector,
string  sFGCDp,
string &  sInterlockType 
)

return the circuit name and the interlock type of a FGC device

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
sPoweringSubSectorinput, the powering sub-sector
sFGCDpinput, the FGC device DP name
sInterlockTypeoutput, the circuit interlock type
Returns:
the circuit
void unLHCCircuit_GenericFunctions_getCircuitDevice ( dyn_string  dsCircuit,
dyn_dyn_string &  ddsDeviceDp,
dyn_dyn_string &  ddsDeviceAlias,
dyn_dyn_string &  ddsDeviceType 
)

GenericFunctions_getCircuitDevice Purpose:

Parameters:

Usage: External function

PVSS manager usage: NG, NV

void unLHCCircuit_GenericFunctions_getCircuitsFromSOC ( anytype  aSOC,
anytype &  aCircuits 
)

Purpose: get the list of SOC

void unLHCCircuit_GenericFunctions_getCircuitType ( anytype  aCircuit,
anytype &  aInterlockType,
anytype &  aCircuitType 
)

GenericFunctions_getCircuitType Purpose:

Parameters:

Usage: External function

PVSS manager usage: NG, NV

void unLHCCircuit_GenericFunctions_getDPEtoWidgetCB ( dyn_string  dsDeviceDpe,
dyn_string  dsFrontEndDp,
dyn_string &  dsParameters 
)

GenericFunctions_getDPEtoWidgetCB

void unLHCCircuit_GenericFunctions_getDPEtoWidgetCB_Circuits ( dyn_string  dsDeviceDpe,
dyn_string  dsFrontEndDp,
dyn_string &  dsParameters 
)

GenericFunctions_getDPEtoWidgetCB_Circuits

bool unLHCCircuit_GenericFunctions_getDpNParameters ( const int  iCircuit,
const string  sCircuit,
const string  sInterlockType,
dyn_string &  dsDollars 
)

GenericFunctions_getDpNParameters

string unLHCCircuit_GenericFunctions_getHTMLLink_DollarParam ( )

GenericFunctions_getHTMLLink_DollarParam

void unLHCCircuit_GenericFunctions_getPWSCircuit ( string  sPWS,
dyn_string &  dsCircuit 
)

GenericFunctions_getPWSCircuit Purpose:

Parameters:

Usage: External function

PVSS manager usage: NG, NV

void unLHCCircuit_GenericFunctions_getSOCList ( dyn_string &  dsSOC)

Purpose: get the list of SOC

void unLHCCircuit_GenericFunctions_getSynopticDollarParameters ( const string  sInterlockType,
const string  sCircuitType,
const string  sCircuit,
const dyn_string  dsDpNames,
const dyn_string  dsAliases,
const dyn_string  dsDpTypes,
string &  sQPSType,
dyn_string &  dsQPS,
dyn_string &  dsPIC,
dyn_string &  dsPC,
dyn_string &  dsCBW,
string &  sCRYO,
dyn_string &  dsCircuitInfo 
)

GenericFunctions_getSynopticDollarParameters

void unLHCCircuit_GenericFunctions_getSynopticName ( const string  sCircuit,
const string  sInterlockType,
const string  sDeviceType,
string &  sSymbol 
)

GenericFunctions_getSynopticName

dyn_string unLHCCircuit_GenericFunctions_getSystemNameInvolved ( )

GenericFunctions_getSystemNameInvolved

bool unLHCCircuit_GenericFunctions_isDType_NotConnected ( string  sPoweringSubSector,
string  sCircuit,
string  sInterlockType,
string  sFGCDpe 
)

return true if the circuit is a D type circuit and the address config is not activated

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
sPoweringSubSectorinput, the powering sub-sector
sCircuitinput, the circuit name
sInterlockTypeinput, the interlock type
sFGCDpeinput, the FGC device DPE name
Returns:
true=the circuit is a D type circuit and the address config is not activated/false=all other cases
void unLHCCircuit_GenericFunctions_orderCircuitList ( dyn_string &  dsCircuit)

Purpose: Oder the list of circuit by interlock type and circuit type

Parameters:
dsCircuit,:dyn_string, input/output: the list of circuit.
void unLHCCircuit_GenericFunctions_PWScloseSwitch ( dyn_string  dsDollarParameters,
string  sRef 
)

Purpose: Close all the switches of a powering sub-sectors, function called on a RC from the PWS widget

Parameters:

  • dsDollarParameters: input, dyn_string, list of $-param given to the PWS widget
  • sRef: input, string, reference given to the PWS widget
int unLHCCircuit_GenericFunctions_setDefaultUser ( )

GenericFunctions_setDefaultUser

int unLHCCircuit_GenericFunctions_setFileAccess ( )

GenericFunctions_setFileAccess

void unLHCCircuit_GenericFunctions_sizeCircuitWidget ( )

GenericFunctions_sizeCircuitWidget

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

GenericFunctions_TreeDeviceOverviewWidgetRegisterCB

void unLHCCircuit_GenericFunctions_widgetCB_Animation ( )

GenericFunctions_widgetCB_Animation Purpose:

Parameters:

Usage: External function

PVSS manager usage: NG, NV

bool unLHCCircuit_GenericFunctions_widgetCB_checkParameters ( const string  sText,
const int  iNum 
)

GenericFunctions_widgetCB_checkParameters

void unLHCCircuit_GenericFunctions_widgetCB_main ( )

GenericFunctions_widgetCB_main Purpose:

Parameters:

Usage: External function

PVSS manager usage: NG, NV

bool unLHCCircuit_GenericFunctions_widgetCB_setPC_state ( )

Set the FGC state

Constraints
None
Usage
Public
PVSS managers
Ui
Parameters:
dsDPEinput, list of DPE
Returns:
true=OK/false=BAD
void unLHCCircuit_GenericFunctions_WidgetRegister ( )

GenericFunctions_WidgetRegister

void unLHCCircuit_getDollarModule ( const string  sCircuits,
const string  sInterlockTypes,
const string  sCircuitTypes,
dyn_string &  dsCircuits,
dyn_string &  dsInterlockTypes,
dyn_string &  dsCircuitTypes 
)

getDollarModule

 All Files Functions