Main Page | File List | File Members

lbArchive.ctl File Reference


Functions

int lbArchive_setRDBuser (string user)
int lbArchive_setRDBhost (string host)
int lbArchive_setRDBpwd (string pwd)
string lbArchive_getRDBuser ()
string lbArchive_getRDBhost ()
int lbArchive_setArchOn (string dpe, int smoothing_type, time time_sc, float tol_val)
int lbArchive_setArchOff (string dpe)
bool lbArchive_isDPEon (string dpe)
int lbArchive_getRDBMngrPos ()
int lbArchive_getRDBState ()
int lbArchive_startRDB ()
int lbArchive_stopRDB ()
dyn_string lbArchive_RDBstatus ()
dyn_string lbArchive_dpeArchOld ()
int lbArchive_archvToRDB (string dpe)
int setRDBparameter (string param, string value)
string getRDBparameter (string param)
int setConfigEntry (string sectionName, string key, string value)
bool findConfigEntry (string sectionName, string key, dyn_string &section, int &index)
bool belong (anytype obj, dyn_anytype set)

Variables

int user = 0
int man = convManIdToInt(UI_MAN, 1)
int prio = PRIO_WARNING
int typ = ERR_PARAM
int co = 29
bit32 bit = 0
errClass myError

Detailed Description

A library including the necessary functions to handle the archiving of PVSS data into an Oracle DB

Creation Date
24/10/2007
Author:
Maria del Carmen Barandela

Function Documentation

int lbArchive_archvToRDB string  dpe  ) 
 

Sets the archiving of a given dpe to RDB archiving, keeping the other options of the archiving.

Returns 0 if there are no errors or -1 in any other case.

Usage
Public
PVSS managers
RDB

dyn_string lbArchive_dpeArchOld  ) 
 

Returns a dyn_string containing the name of the dpes with file archiving settings.

This function returns a void dyn_string in the case that no file archiving have been defined.

Usage
Public
PVSS managers
RDB

string lbArchive_getRDBhost  ) 
 

Returns a string defining the host used for RDB archiving.

Usage
Public
PVSS managers
RDB

int lbArchive_getRDBMngrPos  ) 
 

Returs the position of the RDB manager in the project.

If there is no RDB manager this function returns -1.

Usage
Public
PVSS managers
RDB

int lbArchive_getRDBState  ) 
 

Returns the status of the RDB manager.

The return value can be:

0: Manager stopped

1: Manager init

2: Manager running

3: Manager blocked

-1: If the rdb manager is not found in the project

Usage
Public
PVSS managers
RDB

string lbArchive_getRDBuser  ) 
 

Returns a string with the user used for RDB archiving.

Usage
Public
PVSS managers
RDB

bool lbArchive_isDPEon string  dpe  ) 
 

Returns true if the archiving of a dpe is set to TRUE. FALSE in any other case.

Usage
Public
PVSS managers
RDB

dyn_string lbArchive_RDBstatus  ) 
 

This functions return a dyn_string with all the possible errors in the RDB parameters.

There are 6 posibilities:

RDB parameters OK: all the manager parameters are OK and is posible to make a valid connection to the oracle db

NOT RDB user: there is no user name definition in the RDB manager

NOT RDB host: there is no conecction string to the db server defined in the RDB manager

NOT RDB password: there is no password entered to connect to the db

NOT RDB connection with the actual parameters: is not posible to stablish a connection to the oracle db

NOT RDB internal DP: there is not RDB internal DP

Usage
Public
PVSS managers
RDB

int lbArchive_setArchOff string  dpe  ) 
 

Set the archiving of a dpe to OFF.

Returns 0 if no errors happenned.

Usage
Public
PVSS managers
RDB

int lbArchive_setArchOn string  dpe,
int  smoothing_type,
time  time_sc,
float  tol_val
 

Set the archiving of a dpe to ON.

The smoothing_type can be: -1: no smoothing

0: Value dependent(absolute value)

1: Time dependent

2: Absolute value AND time

3: Absolute value OR time

4: Old/New comparison

5: Old/New comparison and time

6: Old/New comparison or time

7: Value dependent relative

8: Value dependent relative and time

9: Value dependent relative or time

Returns 0 if no errors happenned.

Usage
Public
PVSS managers
RDB

int lbArchive_setRDBhost string  host  ) 
 

Sets the host for RDB archiving to host.

To make effective the change the RDB Archive manager must be restarted after this is done.

Usage
Public
PVSS managers
RDB

int lbArchive_setRDBpwd string  pwd  ) 
 

Sets the password for RDB archiving to pwd . To make effective the change the RDB Archive manager must be restarted after this is done.

Usage
Public
PVSS managers
RDB

int lbArchive_setRDBuser string  user  ) 
 

Sets the user for RDB archiving to user.

To make effective the change the RDB Archive manager must be restarted after this is done.

Usage
Public
PVSS managers
RDB

int lbArchive_startRDB  ) 
 

This function starts the RDB manager.

Returns 0 if no errors happenned or -1 if it was no possible to start the manager.

Usage
Public
PVSS managers
RDB

int lbArchive_stopRDB  ) 
 

This funciotn stops the RDB manager.

Returns 0 if no errors happenned or -1 if it was no possible to stop the manager.

Usage
Public
PVSS managers
RDB


Generated on Tue Jan 15 19:43:21 2008 for lbArchive by  doxygen 1.3.9.1