class QucMidas

class QucMidas : public CorBase

A simple interface to Midas tables

Inheritance:

public members:

static int

TableOpen ( const CorString aName, int& aNumber )

const CorString	aName
int&	aNumber

static void

ReadColumn ( int aTableID, const CorString aHeading, double* anArray, CorString& aUnit, int* aSelectionFlag )

int	aTableID
const CorString	aHeading
double*	anArray
CorString&	aUnit
int*	aSelectionFlag

static void

CloseTable ( int aTable )

int	aTable

static int

SCSPRO ( CorString aThing )

CorString

aThing

static int

SCSEPI ()

static void

ReadCharColumn ( int aTableID, const CorString& aHeading, char** anArray )

int	aTableID
const CorString&	aHeading
char**	anArray

protected members:

QucMidas ()

QucMidas ( const QucMidas & aRef )

const QucMidas &

aRef

QucMidas &

operator= ( const QucMidas & aRef )

const QucMidas &

aRef

virtual

~QucMidas ()

Documentation

SYNOPSIS
    #include <QucMidas.h>
  
    QucMidas myObject;
  
DESCRIPTION
This class encapsulates a few simple interface functions to the Midas tables.
CAUTIONS
<optional>
EXAMPLES
<optional>
SEE ALSO
CorBase

static int TableOpen ( const CorString aName, int& aNumber )

Purpose
Open a Midas Table.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a table id.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const CorString aName: table name
int& aNumber: number of rows (output)

static void ReadColumn ( int aTableID, const CorString aHeading, double* anArray, CorString& aUnit, int* aSelectionFlag )

Purpose
Read a column of values and store them in a provided array.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

int aTableID: table to read
const CorString aHeading: heading of the column
double* anArray: array to store values in (output)
CorString& aUnit: unit of the table elements (output)
int* aSelectionFlag: array containting whether the respective element is set (1/0)

static void CloseTable ( int aTable )

Purpose
Close a Midas table.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

int aTable: table id

static int SCSPRO ( CorString aThing )

Purpose
Read keywords database, intialize File Control Table and open logfile.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns an error code (o = OK).

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aThing: name of calling program

static int SCSEPI ()

Purpose
Write keywords back, clean up everything.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function only returns an error code or if we are outside Midas. Otherwise this function will exit().

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

static void ReadCharColumn ( int aTableID, const CorString& aHeading, char** anArray )

Purpose
Read a column of character strings.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

int aTableID: table id
const CorString& aHeading: name of the column
char** anArray: array to store strings

QucMidas ()

Purpose
The default c'tor.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

QucMidas ( const QucMidas & aRef )

Purpose
The copy c'tor creates a new instance from a reference.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucMidas & aRef: the reference instance

QucMidas & operator= ( const QucMidas & aRef )

Purpose
The assignment operator makes this instance look like another one.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
A reference to this instance.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucMidas & aRef: the reference instance

virtual ~QucMidas ()

Purpose
The d'tor. If it's not in a hierarchy it probably doesn't want to be virtual.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

this class has no child classes.

alphabetic index hierarchy of classes

VLT-DFS Subsystem Core - User Manual 1.1

VLT-MAN-ESO-19000-0001

generated by doc++