unLHCLoggingDB 9.3.0
unLHCLoggingDBSettings.ctl File Reference

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)
 

Detailed Description

Library containing settings related functions of the unLHCLoggingDB component.

Date
04/09/2014
Author
Josef Hofer

Library of the unLHCLoggingDB component used only by unLHCLoggingDB.

PVSS manager usage: CTRL, UI

Constraints:

  • PVSS version: 3.11
  • Operating System: Linux

Function Documentation

◆ unLHCLoggingDBSettings_getDbConfigDpName()

string unLHCLoggingDBSettings_getDbConfigDpName ( string  sDbName,
string  sDbUser 
)

Get name of settings Dp

Parameters
sDbNameinput, name of the database
sDbUserinput, name of the database
Returns
output, name of the datapoint

◆ unLHCLoggingDBSettings_getSettingsDpeName()

bool unLHCLoggingDBSettings_getSettingsDpeName ( string &  sDpeName)

Get name of settings dpe

Parameters
sDpeNameoutput, Name of the dpe that holds the settings
Returns
output, true: success, false: error

◆ unLHCLoggingDBSettings_getActiveDbConfigDp()

bool unLHCLoggingDBSettings_getActiveDbConfigDp ( string &  sDpName)

Get name of datapoint, that holds database settings

Parameters
sDpNameoutput, Name of the database configuration datapoint
Returns
output, true: success, false: error

◆ unLHCLoggingDBSettings_setActiveDbConfigDp()

bool unLHCLoggingDBSettings_setActiveDbConfigDp ( string  sDpName)

Set name of datapoint, that holds database settings

Parameters
sDpNameinput, Name of the database configuration datapoint
Returns
output, true: success, false: error

◆ unLHCLoggingDBSettings_getDbConfig()

bool unLHCLoggingDBSettings_getDbConfig ( string  sDbConfigDp,
string &  sDbName,
string &  sDbUser,
string &  sDbPass 
)

Get data from a specific database configuration datapoint

Parameters
sDbConfigDpinput, Name of the database configuration datapoint
sDbNameoutput, database name
sDbUseroutput, database user
sDbPassoutput, database password (encrypted)
Returns
output, true: success, false: error

◆ unLHCLoggingDBSettings_setDbConfig()

bool unLHCLoggingDBSettings_setDbConfig ( string  sDbConfigDp,
string  sDbName,
string  sDbUser,
string  sDbPass 
)
private

Set data of a specific database configuration datapoint

Parameters
sDbConfigDpinput, Name of the database configuration datapoint
sDbNameinput, database name
sDbUserinput, database user
sDbPassinput, database password (encrypted)
Returns
output, true: success, false: error

◆ unLHCLoggingDBSettings_getActiveDbConfig()

bool unLHCLoggingDBSettings_getActiveDbConfig ( string &  sDbName,
string &  sDbUser,
string &  sDbPass 
)

Get database settings of active database

Parameters
sDbNameoutput, database name
sDbUseroutput, database user
sDbPassoutput, database password (encrypted)
Returns
output, true: success, false: error

◆ unLHCLoggingDBSettings_getAllDbConfigDps()

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

Parameters
dsDbConfigDpsoutput, database configuration datapoint names
dsDbNamesoutput, database names
dsDbUsersoutput, database users
dsDbPasswordsoutput, database passwords (encrypted)
dbDpEditableoutput, true=dbConfigDp is editable; false dbConfigDp is read only
Returns
output, true: success, false: error

◆ unLHCLoggingDBSettings_setAllDbConfigDps()

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

Parameters
dsDbConfigDpsinput, database configuration datapoint names
dsDbNamesinput, database names
dsDbUsersinput, database users
dsDbPasswordsinput, database passwords (encrypted)
Returns
output, true: success, false: error

◆ unLHCLoggingDBSettings_getMySystemDbSchema()

string unLHCLoggingDBSettings_getMySystemDbSchema ( )

Get db user from the archive configuration of the current system

Returns
mySystemDbSchema output, Schema name as string

◆ unLHCLoggingDBSettings_getTimeStampMode()

bool unLHCLoggingDBSettings_getTimeStampMode ( )

Read mode of time stamps from datapoint

Returns
bUTC output, 0=localtime 1=UTC

◆ unLHCLoggingDBSettings_setTimeStampMode()

bool unLHCLoggingDBSettings_setTimeStampMode ( bool  bUTC)

Write mode of time stamps to datapoint

Parameters
bUTCinput, 0=localtime 1=UTC
Returns
output, true: success, false: error

◆ unLHCLoggingDBSettings_getConfigFileGeneratorFunction()

string unLHCLoggingDBSettings_getConfigFileGeneratorFunction ( string  sSystemName = getSystemName())

Get the name of the default user defined config file generator function

Returns
Name of the function

◆ unLHCLoggingDBSettings_setConfigFileGeneratorFunction()

bool unLHCLoggingDBSettings_setConfigFileGeneratorFunction ( string  sFunction)

Set the name of the default user defined config file generator function

Parameters
sFunctioninput, Name of the function
Returns
true:success, false:error

◆ unLHCLoggingDBSettings_getSettingsForConfigFileGeneratorRule()

mapping unLHCLoggingDBSettings_getSettingsForConfigFileGeneratorRule ( string  sRuleName,
string  sSystemName = getSystemName() 
)

Get settings for a specific config file generator rule

Parameters
sRuleNameinput, Name of the rule
sSystemNameinput, system name
Returns
Settings as a mapping

◆ unLHCLoggingDBSettings_getSettingsForDefaultConfigFileGeneratorRule()

mapping unLHCLoggingDBSettings_getSettingsForDefaultConfigFileGeneratorRule ( string  sSystemName)
private

Get default settings for a specific config file generator rule

Parameters
sSystemNameinput, system name
Returns
Settings as a mapping

◆ unLHCLoggingDBSettings_setSettingsForConfigFileGeneratorRule()

void unLHCLoggingDBSettings_setSettingsForConfigFileGeneratorRule ( string  sRuleName,
const mapping &  mSettings 
)

Set settings for a specific config file generator rule DP

Parameters
sRuleNameinput, Name of the rule
mSettingsinput, Settings to save

◆ unLHCLoggingDBSettings_createConfigFileGeneratiorRule()

void unLHCLoggingDBSettings_createConfigFileGeneratiorRule ( string  sRuleName)
private

Create a new config file generator rule DP

Parameters
sRuleNameinput, Name of the rule

◆ unLHCLoggingDBSettings_deleteConfigFileGeneratorRule()

void unLHCLoggingDBSettings_deleteConfigFileGeneratorRule ( string  sRuleName)

Delete one specific config file generator rule DP

Parameters
sRuleNameinput, Name of the rule

◆ unLHCLoggingDBSettings_getConfigFileGeneratorRules()

dyn_string unLHCLoggingDBSettings_getConfigFileGeneratorRules ( bool  excludeManuallyMaintained,
bool  excludeTestConfig,
string  sSystemName = getSystemName() 
)

Get names of all config file generator rules

Parameters
excludeManuallyMaintainedinput, don't put manually maintained configurations into the list
excludeTestConfiginput, don't put test configuraitons into the list
sSystemNameinput, system name
Returns
List of rules

◆ unLHCLoggingDBSettings_isFileNameUnique()

bool unLHCLoggingDBSettings_isFileNameUnique ( string  fileName,
string  ruleName 
)

Check if the file name given as parameter is not already used by another configuration

Parameters
fileNameinput, file name to be checked
ruleNameinput, name of the rule associated to the file name to exclude it from the comparison list
Returns
true if the filename is unique (i.e. not already taken by a configuration), false otherwise

◆ unLHCLoggingDBSettings_isRuleNameExist()

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