unLHCLoggingDB 9.3.0
unLHCLoggingDBUserLib.ctl File Reference

Library containing functions to retrieve configuration data for unLHCLoggingDB. More...

Functions

void unLHCLoggingDBUserLib_getDeviceInfo_BASIC (string sFullDpeName, string &sName, string &sDescription, string &sHierarchy, string &sDpAlias, string &sDpeExtension)
 
void unLHCLoggingDBUserLib_getDeviceInfo_UNICOS (string sFullDpeName, string &sName, string &sDescription, string &sHierarchy, string &sDpAlias, string &sDpeExtension)
 
void unLHCLoggingDBUserLib_getSystemAlarmInfo (const dyn_string dsDpe, const string sLocation, string &sDpe, string &sDescription, string &sAlias, string &sName, string &sHierarchy)
 

Variables

const string cs_unLHCLoggingDBUserLib_Error = "ERROR"
 set sHierarchy to 'ERROR', if information cannot be retrieved for the given DPE
 
const string cs_unLHCLoggingDBUserLib_Ignore = "IGNORE"
 set sHierarchy to 'IGNORE', if you want to ignore a certain name (eg. for SPARE or RESERVE)
 
const string cs_unLHCLoggingDBUserLib_Activity = "CRYO"
 string constant to build hierarchy for cryo
 

Detailed Description

Library containing functions to retrieve configuration data for unLHCLoggingDB.

Date
17/11/2014
Author
: Josef Hofer

The functions are receiving the full data point element name as an input parameter and are returning name, hierarchy, alias and element extension as output parameters

Usage: Public

PVSS manager usage: CTRL, UI

Constraints:

  • PVSS version: 3.11
  • Operating System: Linux

Function Documentation

◆ unLHCLoggingDBUserLib_getDeviceInfo_BASIC()

void unLHCLoggingDBUserLib_getDeviceInfo_BASIC ( string  sFullDpeName,
string &  sName,
string &  sDescription,
string &  sHierarchy,
string &  sDpAlias,
string &  sDpeExtension 
)

This is the very basic function for retrieving logging config data. It can be used for developement purpose, ore if there is no user function and the devices do not fit into the UNICOS naming scheme.

Reviewed:
2018-08-16 Callback
Parameters
sFullDpeNameinput, full data point element name
sNameoutput, variable name
sDescriptionoutput, description
sHierarchyoutput, systemName/dpType
sDpAliasoutput, alias
sDpeExtensionoutput, element extension

◆ unLHCLoggingDBUserLib_getDeviceInfo_UNICOS()

void unLHCLoggingDBUserLib_getDeviceInfo_UNICOS ( string  sFullDpeName,
string &  sName,
string &  sDescription,
string &  sHierarchy,
string &  sDpAlias,
string &  sDpeExtension 
)

This is the default function for retrieving logging config data for UNICOS devices.

sDpAlias + sDpeExtension is used to display the sFullDpeName in a more human readable form.

Reviewed:
2018-08-16 Callback
Parameters
sFullDpeNameinput, full data point element name
sNameoutput, variable name
sDescriptionoutput, description
sHierarchyoutput, Activity/Location/Application/Nature/Domain;
sDpAliasoutput, alias
sDpeExtensionoutput, element extension

◆ unLHCLoggingDBUserLib_getSystemAlarmInfo()

void unLHCLoggingDBUserLib_getSystemAlarmInfo ( const dyn_string  dsDpe,
const string  sLocation,
string &  sDpe,
string &  sDescription,
string &  sAlias,
string &  sName,
string &  sHierarchy 
)

This is the default function for retrieving logging config data for system alarms.

Parameters
dsDpeinput, splitted full dpe name
sLocationinput, location string
sDpeoutput, full name of the sytem alarm dpe
sDescriptionoutput, description of the sytem alarm dpe
sAliasoutput, empty string
sNameoutput, alarm name
sHierarchyoutput, activity/location/PVSS_INTEGRITY

!!!!!!!! cst has to be replaced