libs/unLHCCircuit_TreeOverview.ctl File Reference

Functions

LHCCircuit Tree functions

Library for the functions used by the LHC_CIRCUIT tree overview (Common PC, QPS and PIC)

 unLHCCircuit_TreeOverview_initialize (bit32 b32InitSelectState, bit32 b32InitSortByState, dyn_string dsExcludedDeviceType, dyn_string &exInfo)
 unLHCCircuit_TreeOverview_setCheckboxState (bool bState, bool bSOC)
 unLHCCircuit_TreeOverview_displayCallBack (string sCommandDp, int iCommand, string sSystemNameDp, string sSystemName)
 unLHCCircuit_TreeOverview_buildList ()
 _unLHCCircuit_TreeOverview_buildList ()
 unLHCCircuit_TreeOverview_getCircuitDeviceProperty (string sSystemName, dyn_string &dsPWS, dyn_string &dsCircuit, dyn_string &dsInterlockType, dyn_string &dsCircuitType, dyn_string &dsBuilding, int &iDeviceNumber)
bool unLHCCircuit_TreeOverview_checkDeviceListSize (dyn_dyn_string ddsList)
 _unLHCCircuit_TreeOverview_getCircuitDeviceProperty (const string sSystemName, dyn_dyn_string &ddsDeviceList, dyn_string &dsPWS, dyn_string &dsCircuit, dyn_string &dsInterlockType, dyn_string &dsCircuitType, dyn_string &dsBuilding, int &iDeviceNumber)
 unLHCCircuit_TreeOverview_getCircuit (dyn_string dsPWS, dyn_string dsInterlockType, dyn_string dsCircuitType, dyn_string &dsCircuit)
 unLHCCircuit_TreeOverview_getCircuitInterlockAndType (dyn_string dsPWS, dyn_string dsInterlockType, dyn_string dsCircuitType, dyn_string &dsCircuit, dyn_string &dsCircuitInterlockType, dyn_string &dsCircuitCircuitType)
 unLHCCircuit_TreeOverview_applyFilter (shape shTreeShape, bit32 b32SelectState, bit32 b32SortByState, string sRegisteredSystem, bool bRegisterSystem)
bool unLHCCircuit_TreeOverview_checkSelectState (bit32 b32SelectState)
 unLHCCircuit_TreeOverview_setSelectState (bit32 b32SelectState)
 unLHCCircuit_TreeOverview_selectSortDeviceList (bit32 b32SelectState, bit32 b32SortByState, string sSystemName, bool bSelect, bool bSortBy, dyn_string &dsNodeInTree, dyn_bool &dbTopNode)
 unLHCCircuit_TreeOverview_getSelectedDeviceList (bit32 b32SelectState, string sSystemName, dyn_dyn_string ddsDeviceList, dyn_dyn_string &ddsSelectedDevice)
 unLHCCircuit_TreeOverview_sortSelectedDeviceList (bit32 b32SortByState, string sSystemName, dyn_dyn_string ddsDeviceList, dyn_string &dsNodeInTree, dyn_bool &dbTopNode, dyn_string &dsCircuitAdded, mapping &m_ddsNodeDevice, string sSelectedKey, string sSelectedLabel)
 unLHCCircuit_TreeOverview_DoubleClick (string sSelectedKey, string sMode, string sCompositeLabel, string sGraphTree, string sBar, bool bClipboard)
 unLHCCircuit_TreeOverview_getCircuitList (string sTreeName, string sSelectedKey, string sCompositeLabel, dyn_string &dsDeviceName, dyn_string &dsParentDeviceName)
 unLHCCircuit_TreeOverview_initializeCircuitToDisplay (dyn_string dsDeviceName)
 unLHCCircuit_TreeOverview_removedDisplayedCircuit ()
 unLHCCircuit_TreeOverview_displayCircuit (int newBeginCircuit, int newEndCircuit)
 unLHCCircuit_TreeOverview_distributedRegister (dyn_string &exceptionInfo)
 unLHCCircuit_TreeOverview_filterChanged ()
 _unLHCCircuit_TreeOverview_buildDeviceList ()
 unLHCCircuit_TreeOverview_getCircuitDevice (string sCircuit, dyn_string &dsCircuitDeviceDp, dyn_string &dsCircuitDeviceAlias, dyn_string &dsCircuitDeviceType)
void unLHCCircuit_TreeOverview_getCryoDeviceList (const string sSystemName, dyn_dyn_string &ddsDeviceDetail)

Detailed Description

Authors:
: Herve Milcent AB/CO-IS
Date:
: 12/04/2007

Modification History:

01/01/2011: Herve


Function Documentation

_unLHCCircuit_TreeOverview_buildDeviceList ( )

Purpose: Build the device list for all the known circuits

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

_unLHCCircuit_TreeOverview_buildList ( )

Purpose: Build the list of subsystem1 and subsystem2

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

_unLHCCircuit_TreeOverview_getCircuitDeviceProperty ( const string  sSystemName,
dyn_dyn_string &  ddsDeviceList,
dyn_string &  dsPWS,
dyn_string &  dsCircuit,
dyn_string &  dsInterlockType,
dyn_string &  dsCircuitType,
dyn_string &  dsBuilding,
int &  iDeviceNumber 
)

Purpose: Build the list of subsystem1 and subsystem2

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

unLHCCircuit_TreeOverview_applyFilter ( shape  shTreeShape,
bit32  b32SelectState,
bit32  b32SortByState,
string  sRegisteredSystem,
bool  bRegisterSystem 
)

Purpose: Apply the new filter: erase everything and add all the system connected

unLHCCircuit_TreeOverview_buildList ( )

Purpose: Build the list of subsystem1 and subsystem2

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

bool unLHCCircuit_TreeOverview_checkDeviceListSize ( dyn_dyn_string  ddsList)

Purpose: check the size of the dyn_string

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

bool unLHCCircuit_TreeOverview_checkSelectState ( bit32  b32SelectState)

Purpose: Check if the filter was modified.

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

unLHCCircuit_TreeOverview_displayCallBack ( string  sCommandDp,
int  iCommand,
string  sSystemNameDp,
string  sSystemName 
)

Purpose: callback handling the the tree device display

  • DEVUN_ADD_COMMAND: add the data of a given system name
  • DEVUN_DELETE_COMMAND: delete the data of a given system name
  • DEVUN_APPLYFILTER_COMMAND: apply the new filter setting
Parameters:
sCommandDp,:string, input: the command DP
iCommand,:int, input: the command to execute.
sSystemNameDp,:string, input: the system DP
sSystemName,:string, input: the system name

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

unLHCCircuit_TreeOverview_displayCircuit ( int  newBeginCircuit,
int  newEndCircuit 
)

Purpose: Show the circuits in the circuit overview

Parameters:
newBeginCircuit,:string, input: start position in the list of circuits.
newEndCircuit,:dyn_string, input: end position in the list of circuits.

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

unLHCCircuit_TreeOverview_DoubleClick ( string  sSelectedKey,
string  sMode,
string  sCompositeLabel,
string  sGraphTree,
string  sBar,
bool  bClipboard 
)

Purpose: Function called called when a click on a node of the unTreeWidget is done.

Parameters:
sSelectedKey,:string, input: the key of the node that was selected in the unTreeWidget, the format of the sSelectedKey is sContext|childrenLabel parentKey
sMode,:string, input: the type of mouse click
sCompositeLabel,:string, input: the composite label of the node
sGraphTree,:string, input: the name of the unTreeWidget graphical element
sBar,:string, input: the name of the the Microsoft ProgressBar Control, version 6.0 graphical element
bClipboard,:bool, input: true show the clipboard, false don't show the clipboard

Constraints: the Microsoft ProgressBar Control, version 6.0

unLHCCircuit_TreeOverview_filterChanged ( )

Purpose: Evaluate if something changed in the filter compared to the current one applied and show it

unLHCCircuit_TreeOverview_getCircuit ( dyn_string  dsPWS,
dyn_string  dsInterlockType,
dyn_string  dsCircuitType,
dyn_string &  dsCircuit 
)

Purpose: Get the list of circuit

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

unLHCCircuit_TreeOverview_getCircuitDevice ( string  sCircuit,
dyn_string &  dsCircuitDeviceDp,
dyn_string &  dsCircuitDeviceAlias,
dyn_string &  dsCircuitDeviceType 
)

Purpose: Evaluate if something changed in the filter compared to the current one applied and show it

Parameters:
sCircuit,:string, input: the circuit name.
dsCircuitDeviceDp,:dyn_string, output: the list of device Dp of the circuit.
dsCircuitDeviceAlias,:dyn_string, output: the list of device name of the circuit.
dsCircuitDeviceType,:dyn_string, output: the list of device type of the circuit.

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

unLHCCircuit_TreeOverview_getCircuitDeviceProperty ( string  sSystemName,
dyn_string &  dsPWS,
dyn_string &  dsCircuit,
dyn_string &  dsInterlockType,
dyn_string &  dsCircuitType,
dyn_string &  dsBuilding,
int &  iDeviceNumber 
)

Purpose: Build the list of subsystem1 and subsystem2

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

unLHCCircuit_TreeOverview_getCircuitInterlockAndType ( dyn_string  dsPWS,
dyn_string  dsInterlockType,
dyn_string  dsCircuitType,
dyn_string &  dsCircuit,
dyn_string &  dsCircuitInterlockType,
dyn_string &  dsCircuitCircuitType 
)

Purpose: Get the list of circuit, circuit type and internlock type

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

unLHCCircuit_TreeOverview_getCircuitList ( string  sTreeName,
string  sSelectedKey,
string  sCompositeLabel,
dyn_string &  dsDeviceName,
dyn_string &  dsParentDeviceName 
)

Purpose: Get the list of children circuit when a left click was done on a node of the tree

Parameters:

Parameters:
sTreeName,:string, input, the unTreeWidget name
sSelectedKey,:string, input, the key of the selected node
sCompositeLabel,:string, input, the compostite label of the selected node
dsDeviceName,:dyn_string, output, the list of children device name of the selected node
dsParentDeviceName,:dyn_string, output, the list of parent (parent of the parent of the parent ...) device DP name of the selected node

Usage: External

PVSS manager usage: NG, NV

Constraints: . Use constants UN_POPUPMENU_*** . PVSS version: 2.12.1 . operating system: NT and W2000, but tested only under W2000. . distributed system: yes.

void unLHCCircuit_TreeOverview_getCryoDeviceList ( const string  sSystemName,
dyn_dyn_string &  ddsDeviceDetail 
)

Purpose: Get the list of CRYO devices and its configuration

Parameters:
sSystemName,:string, input: the system name
ddsDeviceDetail,:dyn_string, output: CRYO devices information

Usage: Public

PVSS manager usage: Ctrl

Constraints: . PVSS version: 3.6 . PVSS manager type: PVSS00Ctrl . operating system: WXP, SLC4 . distributed system: yes.

unLHCCircuit_TreeOverview_getSelectedDeviceList ( bit32  b32SelectState,
string  sSystemName,
dyn_dyn_string  ddsDeviceList,
dyn_dyn_string &  ddsSelectedDevice 
)

Purpose: Get the list of device and its configuration based on the filter selection criteria

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

unLHCCircuit_TreeOverview_initialize ( bit32  b32InitSelectState,
bit32  b32InitSortByState,
dyn_string  dsExcludedDeviceType,
dyn_string &  exInfo 
)

Purpose: Initialize the tree device overview

Parameters:
b32InitSelectState,:b32, input: the filter setup.
b32InitSortByState,:b32, input: the filter setup.
dsExcludedDeviceType,:dyn_string, input: the list of device type to exclude in the tree device overview
exInfo,:dyn_string, output: exception are returned here

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

unLHCCircuit_TreeOverview_initializeCircuitToDisplay ( dyn_string  dsDeviceName)

Purpose: Initialize the circuit list to show and the display variables.

Parameters:
dsDeviceName,:dyn_string, input: the list of device name.

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

unLHCCircuit_TreeOverview_removedDisplayedCircuit ( )

Purpose: Remove all the added symbol circuit in the circuit overview

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

unLHCCircuit_TreeOverview_selectSortDeviceList ( bit32  b32SelectState,
bit32  b32SortByState,
string  sSystemName,
bool  bSelect,
bool  bSortBy,
dyn_string &  dsNodeInTree,
dyn_bool &  dbTopNode 
)

Purpose: Select and/or sort the device list

unLHCCircuit_TreeOverview_setCheckboxState ( bool  bState,
bool  bSOC 
)

Purpose: Set the check box state

Parameters:
bState,:bool, input: true=circuit, false=device
bSOC,:bool, input: true=SOC selected, false=SOC not selected

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

unLHCCircuit_TreeOverview_setSelectState ( bit32  b32SelectState)

Purpose: Keep the current filter setting

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

unLHCCircuit_TreeOverview_sortSelectedDeviceList ( bit32  b32SortByState,
string  sSystemName,
dyn_dyn_string  ddsDeviceList,
dyn_string &  dsNodeInTree,
dyn_bool &  dbTopNode,
dyn_string &  dsCircuitAdded,
mapping &  m_ddsNodeDevice,
string  sSelectedKey,
string  sSelectedLabel 
)

Purpose: Sort the list of selected device.

Usage: Public

PVSS manager usage: UI (PVSS00NV) and UI extended (PVSS00NG)

Constraints: . PVSS version: 3.0 . PVSS manager type: PVSS00NG and PVSS00NV . operating system: WXP. . distributed system: yes.

 All Files Functions