unLHCLoggingDB 9.3.0
|
Library containing settings related functions of the unLHCLoggingDB component. More...
LIBRARY: unLHCLoggingDBSettings.ctl | |
const string | unLHCLoggingDBSettings_sDefaultConfigFileGeneratorFunction = "unLHCLoggingDBUserLib_getDeviceInfo_UNICOS" |
const string | sSettingsDP = "unLHCLoggingDB_Settings" |
Datapoint that holds the name of the active configuration datapoint. | |
const string | sDbConfigDpType = "_UnLHCLoggingDB_Database" |
Datapoints that hold database settings. | |
const string | sDbConfigDpPrefix = "unLHCLoggingDB_Database_" |
const string | sConfigGeneratorRuleDpType = "_UnLHCLoggingDB_ConfigGeneratorRule" |
Datapoints for config file generation. | |
const string | sConfigGeneratorRuleDpPrefix = "unLHCLoggingDB_ConfigGeneratorRule_" |
string | unLHCLoggingDBSettings_getDbConfigDpName (string sDbName, string sDbUser) |
bool | unLHCLoggingDBSettings_getSettingsDpeName (string &sDpeName) |
bool | unLHCLoggingDBSettings_getActiveDbConfigDp (string &sDpName) |
bool | unLHCLoggingDBSettings_setActiveDbConfigDp (string sDpName) |
bool | unLHCLoggingDBSettings_getDbConfig (string sDbConfigDp, string &sDbName, string &sDbUser, string &sDbPass) |
bool | unLHCLoggingDBSettings_setDbConfig (string sDbConfigDp, string sDbName, string sDbUser, string sDbPass) |
bool | unLHCLoggingDBSettings_getActiveDbConfig (string &sDbName, string &sDbUser, string &sDbPass) |
bool | unLHCLoggingDBSettings_getAllDbConfigDps (dyn_string &dsDbConfigDps, dyn_string &dsDbNames, dyn_string &dsDbUsers, dyn_string &dsDbPasswords, dyn_bool &dbDpEditable) |
bool | unLHCLoggingDBSettings_setAllDbConfigDps (const dyn_string &dsDbConfigDps, const dyn_string &dsDbNames, const dyn_string &dsDbUsers, const dyn_string &dsDbPasswords) |
string | unLHCLoggingDBSettings_getMySystemDbSchema () |
bool | unLHCLoggingDBSettings_getTimeStampMode () |
bool | unLHCLoggingDBSettings_setTimeStampMode (bool bUTC) |
string | unLHCLoggingDBSettings_getConfigFileGeneratorFunction (string sSystemName=getSystemName()) |
bool | unLHCLoggingDBSettings_setConfigFileGeneratorFunction (string sFunction) |
mapping | unLHCLoggingDBSettings_getSettingsForConfigFileGeneratorRule (string sRuleName, string sSystemName=getSystemName()) |
mapping | unLHCLoggingDBSettings_getSettingsForDefaultConfigFileGeneratorRule (string sSystemName) |
void | unLHCLoggingDBSettings_setSettingsForConfigFileGeneratorRule (string sRuleName, const mapping &mSettings) |
void | unLHCLoggingDBSettings_createConfigFileGeneratiorRule (string sRuleName) |
void | unLHCLoggingDBSettings_deleteConfigFileGeneratorRule (string sRuleName) |
dyn_string | unLHCLoggingDBSettings_getConfigFileGeneratorRules (bool excludeManuallyMaintained, bool excludeTestConfig, string sSystemName=getSystemName()) |
bool | unLHCLoggingDBSettings_isFileNameUnique (string fileName, string ruleName) |
bool | unLHCLoggingDBSettings_isRuleNameExist (string ruleName) |
Library containing settings related functions of the unLHCLoggingDB component.
Library of the unLHCLoggingDB component used only by unLHCLoggingDB.
PVSS manager usage: CTRL, UI
Constraints:
string unLHCLoggingDBSettings_getDbConfigDpName | ( | string | sDbName, |
string | sDbUser | ||
) |
Get name of settings Dp
sDbName | input, name of the database |
sDbUser | input, name of the database |
bool unLHCLoggingDBSettings_getSettingsDpeName | ( | string & | sDpeName | ) |
Get name of settings dpe
sDpeName | output, Name of the dpe that holds the settings |
bool unLHCLoggingDBSettings_getActiveDbConfigDp | ( | string & | sDpName | ) |
Get name of datapoint, that holds database settings
sDpName | output, Name of the database configuration datapoint |
bool unLHCLoggingDBSettings_setActiveDbConfigDp | ( | string | sDpName | ) |
Set name of datapoint, that holds database settings
sDpName | input, Name of the database configuration datapoint |
bool unLHCLoggingDBSettings_getDbConfig | ( | string | sDbConfigDp, |
string & | sDbName, | ||
string & | sDbUser, | ||
string & | sDbPass | ||
) |
Get data from a specific database configuration datapoint
sDbConfigDp | input, Name of the database configuration datapoint |
sDbName | output, database name |
sDbUser | output, database user |
sDbPass | output, database password (encrypted) |
|
private |
Set data of a specific database configuration datapoint
sDbConfigDp | input, Name of the database configuration datapoint |
sDbName | input, database name |
sDbUser | input, database user |
sDbPass | input, database password (encrypted) |
bool unLHCLoggingDBSettings_getActiveDbConfig | ( | string & | sDbName, |
string & | sDbUser, | ||
string & | sDbPass | ||
) |
Get database settings of active database
sDbName | output, database name |
sDbUser | output, database user |
sDbPass | output, database password (encrypted) |
bool unLHCLoggingDBSettings_getAllDbConfigDps | ( | dyn_string & | dsDbConfigDps, |
dyn_string & | dsDbNames, | ||
dyn_string & | dsDbUsers, | ||
dyn_string & | dsDbPasswords, | ||
dyn_bool & | dbDpEditable | ||
) |
Get database settings of all database configuration datapoints
dsDbConfigDps | output, database configuration datapoint names |
dsDbNames | output, database names |
dsDbUsers | output, database users |
dsDbPasswords | output, database passwords (encrypted) |
dbDpEditable | output, true=dbConfigDp is editable; false dbConfigDp is read only |
bool unLHCLoggingDBSettings_setAllDbConfigDps | ( | const dyn_string & | dsDbConfigDps, |
const dyn_string & | dsDbNames, | ||
const dyn_string & | dsDbUsers, | ||
const dyn_string & | dsDbPasswords | ||
) |
Set database settings of all database configuration datapoints
dsDbConfigDps | input, database configuration datapoint names |
dsDbNames | input, database names |
dsDbUsers | input, database users |
dsDbPasswords | input, database passwords (encrypted) |
string unLHCLoggingDBSettings_getMySystemDbSchema | ( | ) |
Get db user from the archive configuration of the current system
bool unLHCLoggingDBSettings_getTimeStampMode | ( | ) |
Read mode of time stamps from datapoint
bool unLHCLoggingDBSettings_setTimeStampMode | ( | bool | bUTC | ) |
Write mode of time stamps to datapoint
bUTC | input, 0=localtime 1=UTC |
string unLHCLoggingDBSettings_getConfigFileGeneratorFunction | ( | string | sSystemName = getSystemName() | ) |
Get the name of the default user defined config file generator function
bool unLHCLoggingDBSettings_setConfigFileGeneratorFunction | ( | string | sFunction | ) |
Set the name of the default user defined config file generator function
sFunction | input, Name of the function |
mapping unLHCLoggingDBSettings_getSettingsForConfigFileGeneratorRule | ( | string | sRuleName, |
string | sSystemName = getSystemName() |
||
) |
Get settings for a specific config file generator rule
sRuleName | input, Name of the rule |
sSystemName | input, system name |
|
private |
Get default settings for a specific config file generator rule
sSystemName | input, system name |
void unLHCLoggingDBSettings_setSettingsForConfigFileGeneratorRule | ( | string | sRuleName, |
const mapping & | mSettings | ||
) |
Set settings for a specific config file generator rule DP
sRuleName | input, Name of the rule |
mSettings | input, Settings to save |
|
private |
Create a new config file generator rule DP
sRuleName | input, Name of the rule |
void unLHCLoggingDBSettings_deleteConfigFileGeneratorRule | ( | string | sRuleName | ) |
Delete one specific config file generator rule DP
sRuleName | input, Name of the rule |
dyn_string unLHCLoggingDBSettings_getConfigFileGeneratorRules | ( | bool | excludeManuallyMaintained, |
bool | excludeTestConfig, | ||
string | sSystemName = getSystemName() |
||
) |
Get names of all config file generator rules
excludeManuallyMaintained | input, don't put manually maintained configurations into the list |
excludeTestConfig | input, don't put test configuraitons into the list |
sSystemName | input, system name |
bool unLHCLoggingDBSettings_isFileNameUnique | ( | string | fileName, |
string | ruleName | ||
) |
Check if the file name given as parameter is not already used by another configuration
fileName | input, file name to be checked |
ruleName | input, name of the rule associated to the file name to exclude it from the comparison list |
bool unLHCLoggingDBSettings_isRuleNameExist | ( | string | ruleName | ) |
Check if a rule name is already existing in the system, i.e. if a DP for this rule already exists