fwConfigurationDB  8.4.0
fwConfigurationDB_DeviceConfiguration.ctl File Reference

Functions

void _fwConfigurationDB_savePropAddressToDB (dyn_string dpes, dyn_int ipropIds, dyn_string &exceptionInfo)
 
void _fwConfigurationDB_savePropAlertsToDB (dyn_string dpes, dyn_int ipropIds, string configurationName, dyn_string &exceptionInfo)
 
void _fwConfigurationDB_savePropArchivingToDB (dyn_string dpes, dyn_int ipropIds, dyn_string &exceptionInfo)
 
void fwConfigurationDB_saveDeviceConfigurationInDB (dyn_string deviceList, string hierarchyType, string configurationName, anytype saveConfigs, dyn_string &exceptionInfo, string systemName="", string configurationDescription="")
 
void fwConfigurationDB_saveDeviceConfiguration (dyn_string deviceList, string configurationName, string hierarchyType, dyn_string &exceptionInfo, int options=fwConfigurationDB_deviceConfig_ALLDEVPROPS, bool updateExisting=false, string confDescription="")
 
void fwConfigurationDB_getDevicesInConfiguration (string configurationName, string hierarchyType, string topNode, dyn_dyn_mixed &deviceListObject, dyn_string &exceptionInfo)
 

Detailed Description

This package contains device-configuration functions of the Configuration Database tool

Author
Piotr Golonka (BE/ICS-FD)
Date
November 2019

(c) Copyright CERN, All Rights Reserved

Function Documentation

void _fwConfigurationDB_savePropAddressToDB ( dyn_string  dpes,
dyn_int  ipropIds,
dyn_string &  exceptionInfo 
)

Extracts addressing configuration from PVSS and save to DB

Parameters
dpeslist of the data point element names for which configuration is requested
ipropIdscorresponding list of IPROP_ID identifiers (in the database) of the data-point elements

we assume that the configuration was already created, and ipropIds are valid

void _fwConfigurationDB_savePropAlertsToDB ( dyn_string  dpes,
dyn_int  ipropIds,
string  configurationName,
dyn_string &  exceptionInfo 
)

Extracts alert configuration from PVSS and save to DB

Parameters
dpeslist of the data point element names for which configuration is requested
ipropIdscorresponding list of IPROP_ID identifiers (in the database) of the data-point elements
configurationNamethe name of the current configuration; we need it to resolve the DPEs for summary alerts

we assume that the configuration was already created, and ipropIds are valid

void _fwConfigurationDB_savePropArchivingToDB ( dyn_string  dpes,
dyn_int  ipropIds,
dyn_string &  exceptionInfo 
)

Extracts archiving configuration from PVSS and save to DB

Parameters
dpeslist of the data point element names for which configuration is requested
ipropIdscorresponding list of IPROP_ID identifiers (in the database) of the data-point elements

we assume that the configuration was already created, and ipropIds are valid

void fwConfigurationDB_saveDeviceConfigurationInDB ( dyn_string  deviceList,
string  hierarchyType,
string  configurationName,
anytype  saveConfigs,
dyn_string &  exceptionInfo,
string  systemName = "",
string  configurationDescription = "" 
)
Main function that saves static configuration - compatibility mode
Parameters
saveConfigsmay either be of bool, or of int type; in the former case, passing FALSE means that only the minimal (hierarchy) information is stored; passing TRUE means all configs of the devices are stored. If the int-typed parameter is used it should contain the sum of options refering to the configs that should be stored: the deviceConfigsIndices constants should be used. To store no configs (i.e. only the minimal hierarchy information), one should pass 0; to store all properties one should pass the fwConfigurationDB_deviceConfig_ALLDEVPROPS constant.
void fwConfigurationDB_saveDeviceConfiguration ( dyn_string  deviceList,
string  configurationName,
string  hierarchyType,
dyn_string &  exceptionInfo,
int  options = fwConfigurationDB_deviceConfig_ALLDEVPROPS,
bool  updateExisting = false,
string  confDescription = "" 
)

Main function that saves static configuration

void fwConfigurationDB_getDevicesInConfiguration ( string  configurationName,
string  hierarchyType,
string  topNode,
dyn_dyn_mixed &  deviceListObject,
dyn_string &  exceptionInfo 
)

helper function that shows the devices included in configuration, starting from specified topDevice

if configurationName is empty, it takes the devices of "ITEMS" table (i.e. "all")

topNode should specify the system name for hardware hierarchy; if left empty, all devices from all systems are returned