fwConfigurationDB_Utils.ctl File Reference


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)
void fwConfigurationDB_deviceTypesToDpTypes (dyn_string devTypes, dyn_string &dpTypes, dyn_string &exceptionInfo, bool errorOnNonExistingType=true)
string _fwConfigurationDB_getFwDeviceName (string dptName, dyn_string &exceptionInfo)

Functions

void _fwConfigurationDB_startFunction (string fncName, time &t0)
void _fwConfigurationDB_endFunction (string fncName, time t0)
bool fwConfigurationDB_handleErrors (dyn_string &exceptionInfo)
bool fwConfigurationDB_progress (int operationId, string currentOperation, float progress, dyn_string &exceptionInfo)
void _fwConfigurationDB_progressDialogThread ()
void fwConfigurationDB_openProgressDialog (dyn_int operationIds, dyn_string operationNames)
void fwConfigurationDB_closeProgressDialog ()
void fwConfigurationDB_updateDBStatusIndicator ()
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)
string _fwConfigurationDB_itemIdListForSQLQuery (dyn_int itemIdList)
string _fwConfigurationDB_listToSQLString (string columnName, dyn_string itemIdList)
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 = "3.4.0"
global bool fwConfigurationDB_closeProgressDialog = 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

Detailed Description

This package contains internal functions of the Configuration Database tool

Author:
Piotr Golonka (IT-CO/BE)
Date:
May 2009

Function Documentation

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;

bool fwConfigurationDB_progress ( int  operationId,
string  currentOperation,
float  progress,
dyn_string &  exceptionInfo 
)

reports progress of operation, with handling of "Abort" requests 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 (  ) 

void fwConfigurationDB_openProgressDialog ( dyn_int  operationIds,
dyn_string  operationNames 
)

opens a custom progress bar Used in panels

void fwConfigurationDB_closeProgressDialog (  ) 

void fwConfigurationDB_updateDBStatusIndicator (  ) 

void _fwConfigurationDB_getAlertData ( dyn_dyn_mixed &  recipeObject,
int  row,
dyn_string &  exceptionInfo 
)

Gets the alert settings

This function gets current alert settings for a dp from the system and stores it in the data structure which is a single row of recipeObject. The data point name and data point element are passed in thr recipeRow variable as well.

Parameters:
recipeRow the input/output variable, a single row of the recipeObject refering to a single DPE.
exceptionInfo standard exception handling variable

string _fwConfigurationDB_NodeSystemName ( string  nodeName  ) 

Returns system name of the node. If not specified in nodeName, returns local system

string _fwConfigurationDB_NodeNameWithoutSystem ( string  nodeName  ) 

Returns the device (node) name, ensuring it does not contain system name

string _fwConfigurationDB_NodeNameWithSystem ( string  nodeName,
string  systemName,
dyn_string &  exceptionInfo 
)

Returns the device (node) name, ensuring it has system name in it.

passing "" as systemName means: use local system.

string _fwConfigurationDB_itemIdListForSQLQuery ( dyn_int  itemIdList  ) 

string _fwConfigurationDB_listToSQLString ( string  columnName,
dyn_string  itemIdList 
)

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 
)

performs a dpSet for a list of datapoint elements

the list may contain dpes for many systems - they are sorted/grouped appropriately

The parameters: dpes and values are passed by reference to avoid re-allocation; they are not modified


Variable Documentation

global string _fwConfigurationDB_fileVersion_fwConfigurationDB_Utils_ctl = "3.4.0"

global bool fwConfigurationDB_closeProgressDialog = 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


Generated on Thu May 14 12:06:05 2009 for Configuration Database component by  doxygen 1.4.7