fwConfigurationDB  8.4.2
fwConfigurationDB_Utils.ctl File Reference

Functions

bool fwConfigurationDB_handleErrors (dyn_string &exceptionInfo)
 
bool fwConfigurationDB_checkErrors (dyn_string &exceptionInfo, bool dbRollbackOnError=true)
 
bool fwConfigurationDB_progress (int operationId, string currentOperation, float progress, dyn_string &exceptionInfo, bool dbRollbackOnError=true)
 
void _fwConfigurationDB_progressDialogThread ()
 
void fwConfigurationDB_openProgressDialog (dyn_int operationIds, dyn_string operationNames)
 
void fwConfigutationDB_dpGetManyDist (dyn_string dpes, dyn_mixed &values, dyn_string exceptionInfo)
 
void fwConfigurationDB_genericNotify (string s1, string s2="", string s3="", int errcatEntry=2000, int prio=PRIO_INFO)
 
 _fwConfigurationDB_loadDefaultConnection (dyn_string &exceptionInfo)
 
Private Functions in general module
void _fwConfigurationDB_getPropertiesAndDPEs (string dptName, dyn_string &properties, dyn_string &dpes, string &devTypeName, dyn_string &exceptionInfo, string deviceModel="")
 
dyn_string _fwConfigurationDB_getDPTElements (string dptName, dyn_string &exceptionInfo, bool all=FALSE)
 
void _fwConfigurationDB_getDPTElements2 (string dptName, dyn_string &elementNames, dyn_int &elementTypes, dyn_string &exceptionInfo, bool all=FALSE)
 
int _fwConfigurationDB_typeIdToDpeTypeId (int varType)
 
void _fwConfigurationDB_dataToString (anytype data, int dataType, string listSeparator, string &encodedData, dyn_string &exceptionInfo)
 
void _fwConfigurationDB_stringToData (string encodedData, int dataType, string listSeparator, anytype &data, dyn_string &exceptionInfo)
 
string _fwConfigurationDB_getFwDeviceName (string dptName, dyn_string &exceptionInfo)
 
void _fwConfigurationDB_getAlertData (dyn_dyn_mixed &recipeObject, int row, dyn_string &exceptionInfo)
 
string _fwConfigurationDB_NodeSystemName (string nodeName)
 
string _fwConfigurationDB_NodeNameWithoutSystem (string nodeName)
 
string _fwConfigurationDB_NodeNameWithSystem (string nodeName, string systemName, dyn_string &exceptionInfo)
 
void fwConfigurationDB_dpSetMany (dyn_string &dpes, dyn_mixed &values, dyn_string &exceptionInfo, string systemName="")
 
void fwConfigurationDB_dpSetManyDist (dyn_string &dpes, dyn_mixed &values, dyn_string &exceptionInfo, bool checkDpeExist=false)
 

Detailed Description

This package contains internal functions of the Configuration Database tool

(c) Copyright CERN, All Rights Reserved

Function Documentation

bool fwConfigurationDB_handleErrors ( dyn_string &  exceptionInfo)

Handles standard errors, taking care of closing the progress bars, etc Used in panels typical use would be:

someFunction(parameter, exceptionInfo);
if (fwConfigurationDB_handleErrors(exceptionInfo)) return;
See Also
see also fwConfigurationDB_checkErrors
bool fwConfigurationDB_checkErrors ( dyn_string &  exceptionInfo,
bool  dbRollbackOnError = true 
)

check errors, taking care of closing the progress bars, etc Used in scripts typical use would be:

someFunction(parameter, exceptionInfo);
if (fwConfigurationDB_checkErrors(exceptionInfo,true)) return;
See Also
see also fwConfigurationDB_handleErrors
bool fwConfigurationDB_progress ( int  operationId,
string  currentOperation,
float  progress,
dyn_string &  exceptionInfo,
bool  dbRollbackOnError = true 
)

reports progress of operation, with handling of "Abort" requests and errors it returns TRUE and the "ABORT" exception in the exceptionInfo when the operation needs to be aborted. Used in the library functions typical use would be:

if (fwConfigurationDB_progress(OPER_LoadFile,"Loading file", 35.0, exceptionInfo)) return;
void _fwConfigurationDB_progressDialogThread ( )
Reviewed:
2018-06-22 Thread
void fwConfigurationDB_openProgressDialog ( dyn_int  operationIds,
dyn_string  operationNames 
)

opens a custom progress bar Used in panels

void fwConfigutationDB_dpGetManyDist ( dyn_string  dpes,
dyn_mixed &  values,
dyn_string  exceptionInfo 
)

Wrapper over dpGet to handle many systems

This function allows to get dpe values from many systems (ie. overcome the limitation of dpGet)

void fwConfigurationDB_genericNotify ( string  s1,
string  s2 = "",
string  s3 = "",
int  errcatEntry = 2000,
int  prio = PRIO_INFO 
)

Printout function that uses PVSS error messages.

_fwConfigurationDB_loadDefaultConnection ( dyn_string &  exceptionInfo)
Auto-configures DB-connectivity parameters using fwInstallationTool (CDBSI)
Reviewed:
2018-06-26 StandaloneTool API