unLHCLoggingDB 9.3.0
unLHCLoggingDBUtils.ctl File Reference

Library containing general functions used by the unLHCLoggingDB component. More...

Functions

mapping unLHCLoggingDBUtils_getAuthentication ()
 
void unLHCLoggingDBUtils_resetAuthentication ()
 
bool unLHCLoggingDBUtils_openAuthenticationPanel (string user="")
 
void unLHCLoggingDBUtils_animateProgressBar (int iPercent)
 
void unLHCLoggingDBUtils_displayStepNumber (int currentStep, int totalSteps)
 
void unLHCLoggingDBUtils_toggleColumnVisibility (string table, string column)
 
mapping unLHCloggingDBUtils_makeMapping (anytype first,...)
 

Variables

global mapping g_mAuthN
 

Detailed Description

Library containing general functions used by 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

◆ unLHCLoggingDBUtils_getAuthentication()

mapping unLHCLoggingDBUtils_getAuthentication ( )

Get authentication information, if no information exists then initialise

Returns
g_mAuthN output, authentication information

◆ unLHCLoggingDBUtils_resetAuthentication()

void unLHCLoggingDBUtils_resetAuthentication ( )

Reset authentication information

◆ unLHCLoggingDBUtils_openAuthenticationPanel()

bool unLHCLoggingDBUtils_openAuthenticationPanel ( string  user = "")

Open panel so that the user can authenticate

Parameters
userinput, forced username

◆ unLHCLoggingDBUtils_animateProgressBar()

void unLHCLoggingDBUtils_animateProgressBar ( int  iPercent)

Animate ProgressBar and show some percentage

Parameters
iPercentinput, percent 0 ... 100

◆ unLHCLoggingDBUtils_displayStepNumber()

void unLHCLoggingDBUtils_displayStepNumber ( int  currentStep,
int  totalSteps 
)

Display the step number of an operation

◆ unLHCLoggingDBUtils_toggleColumnVisibility()

void unLHCLoggingDBUtils_toggleColumnVisibility ( string  table,
string  column 
)

Show hidden column, or hide visible column of a table

Parameters
tableinput, name of the table
columninput, name of the column

◆ unLHCloggingDBUtils_makeMapping()

mapping unLHCloggingDBUtils_makeMapping ( anytype  first,
  ... 
)

Make a mapping (missing function in PVSS, to be replaced with standard function, once we have it in a core library)

Parameters
firstinput, variable list of key value pairs
Returns
a mapping

Variable Documentation

◆ g_mAuthN

global mapping g_mAuthN

Global mapping to store authentication information

Structure: g_mAuthN["user"] string username g_mAuthN["pass"] string password g_mAuthN["ok"] bool authentication ok