Configuration Database component  8.3.0
Functions | Variables
fwConfigurationDB_Utils.ctl File Reference

Functions

void _fwConfigurationDB_initNumericConstants ()
 
bool _fwConfigurationDB_collapseFloats (dyn_float &df, dyn_string &exceptionInfo, string what="")
 
bool _fwConfigurationDB_expandFloats (dyn_float &df, dyn_string &exceptionInfo)
 
void _fwConfigurationDB_startFunction (string fncName, time &t0)
 
void _fwConfigurationDB_endFunction (string fncName, time t0)
 
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 fwConfigurationDB_closeProgressDialog ()
 
void fwConfigurationDB_updateDBStatusIndicator ()
 
void fwConfigutationDB_dpGetManyDist (dyn_string dpes, dyn_mixed &values, dyn_string exceptionInfo)
 
void fwConfigurationDB_printDynDynMixed (dyn_dyn_mixed data, dyn_string header="", int maxrows=0, string description="Table")
 
void _fwConfigurationDB_queryPrint (string sql, string description="", int maxRows=10)
 
void _fwConfigurationDB_showItemsInCDB_API_PARAMS (string description="CDB_API_PARAMS")
 
void fwConfigurationDB_genericNotify (string s1, string s2="", string s3="", int errcatEntry=2000, int prio=PRIO_INFO)
 
 _fwConfigurationDB_loadDefaultConnection (dyn_string &exceptionInfo)
 
 _fwConfigurationDB_saveDefaultConnection (string database, string username, string password, 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)
 

Variables

global string _fwConfigurationDB_fileVersion_fwConfigurationDB_Utils_ctl ="8.3.0"
 
global bool g_fwConfigurationDB_closeProgressDialog =FALSE
 
global bool g_fwConfigurationDB_progressDialogClosed =FALSE
 
global dyn_int fwConfigurationDB_operationIds
 
global dyn_string fwConfigurationDB_operationNames
 
global dyn_float fwConfigurationDB_operationsProgress
 
global string fwConfigurationDB_currentOperation
 
global bool fwConfigurationDB_abortOperation =FALSE
 
global bool fwConfigurationDB_pauseOperation =FALSE
 
global float fwConfigurationDB_NaNPlus
 
global float fwConfigurationDB_NaNMinus
 
global float fwConfigurationDB_InfPlus
 
global float fwConfigurationDB_InfMinus
 
global const float fwConfigurationDB_OraNumberLimit = 9.999999999999999e124
 
global const float fwConfigurationDB_InfPlus_ORA = 8.0e125
 
global const float fwConfigurationDB_InfMinus_ORA =-8.0e125
 
global const float fwConfigurationDB_NaNPlus_ORA = 4.0e125
 
global const float fwConfigurationDB_NaNMinus_ORA =-4.0e125
 
global const float fwConfigurationDB_MaxValue_ORA = 1.0e125
 
global const float fwConfigurationDB_MinValue_ORA =-1.0e125
 
global bool _fwConfigurationDB_numericConstantsInitialized =FALSE
 
private const string fwConfigurationDB_CDBSI_Key_database = "ConfigurationDB/dbName"
 
private const string fwConfigurationDB_CDBSI_Key_username = "ConfigurationDB/user"
 
private const string fwConfigurationDB_CDBSI_Key_password = "ConfigurationDB/pwd"
 
private const string fwConfigurationDB_defaultConnectionName = "default_connection"
 

Detailed Description

This package contains internal functions of the Configuration Database tool

Author
Piotr Golonka (BE/ICS-FD)
Date
Decemver 2018

(c) Copyright CERN, All Rights Reserved

Function Documentation

void _fwConfigurationDB_initNumericConstants ( )
bool _fwConfigurationDB_collapseFloats ( dyn_float &  df,
dyn_string &  exceptionInfo,
string  what = "" 
)
bool _fwConfigurationDB_expandFloats ( dyn_float &  df,
dyn_string &  exceptionInfo 
)
void _fwConfigurationDB_startFunction ( string  fncName,
time &  t0 
)
void _fwConfigurationDB_endFunction ( string  fncName,
time  t0 
)
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 fwConfigurationDB_closeProgressDialog ( )
void fwConfigurationDB_updateDBStatusIndicator ( )
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_printDynDynMixed ( dyn_dyn_mixed  data,
dyn_string  header = "",
int  maxrows = 0,
string  description = "Table" 
)
void _fwConfigurationDB_queryPrint ( string  sql,
string  description = "",
int  maxRows = 10 
)
void _fwConfigurationDB_showItemsInCDB_API_PARAMS ( string  description = "CDB_API_PARAMS")
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
_fwConfigurationDB_saveDefaultConnection ( string  database,
string  username,
string  password,
dyn_string &  exceptionInfo 
)

Variable Documentation

global string _fwConfigurationDB_fileVersion_fwConfigurationDB_Utils_ctl ="8.3.0"
global bool g_fwConfigurationDB_closeProgressDialog =FALSE
global bool g_fwConfigurationDB_progressDialogClosed =FALSE
global dyn_int fwConfigurationDB_operationIds
global dyn_string fwConfigurationDB_operationNames
global dyn_float fwConfigurationDB_operationsProgress
global string fwConfigurationDB_currentOperation
global bool fwConfigurationDB_abortOperation =FALSE
global bool fwConfigurationDB_pauseOperation =FALSE
global float fwConfigurationDB_NaNPlus
global float fwConfigurationDB_NaNMinus
global float fwConfigurationDB_InfPlus
global float fwConfigurationDB_InfMinus
global const float fwConfigurationDB_OraNumberLimit = 9.999999999999999e124
global const float fwConfigurationDB_InfPlus_ORA = 8.0e125
global const float fwConfigurationDB_InfMinus_ORA =-8.0e125
global const float fwConfigurationDB_NaNPlus_ORA = 4.0e125
global const float fwConfigurationDB_NaNMinus_ORA =-4.0e125
global const float fwConfigurationDB_MaxValue_ORA = 1.0e125
global const float fwConfigurationDB_MinValue_ORA =-1.0e125
global bool _fwConfigurationDB_numericConstantsInitialized =FALSE
private const string fwConfigurationDB_CDBSI_Key_database = "ConfigurationDB/dbName"
private const string fwConfigurationDB_CDBSI_Key_username = "ConfigurationDB/user"
private const string fwConfigurationDB_CDBSI_Key_password = "ConfigurationDB/pwd"
private const string fwConfigurationDB_defaultConnectionName = "default_connection"