class QucFunction1D

class QucFunction1D : public CorBase

a two dimensional array of assiciated values

Inheritance:

public members:

QucFunction1D ( CorString aName = "myframe", int aSize = 1, QucUnitType unitX = QucUNIT_LESS, QucUnitType unitY = QucUNIT_LESS )

CorString	aName
int	aSize
QucUnitType	unitX
QucUnitType	unitY

QucFunction1D ( const QucFunction1D & aRef )

const QucFunction1D &

aRef

QucFunction1D &

operator= ( const QucFunction1D & aRef )

const QucFunction1D &

aRef

virtual

~QucFunction1D ()

void

setValue ( int anIndex, double aTuple1, double aTuple2 )

int	anIndex
double	aTuple1
double	aTuple2

void

setInDir ( CorString aDirectory )

CorString

aDirectory

void

readFile ( CorString aFileName, CorString aType = "table", CorString aWave = ":WAVE", CorString aFlux = ":FLUX" )

CorString	aFileName
CorString	aType
CorString	aWave
CorString	aFlux

double

getX ( int anIndex ) const

int	anIndex

double

getY ( int anIndex ) const

int	anIndex

double

getValueAt ( double anIndex, QucUnitType unitX = QucUNIT_LESS, QucUnitType unitY = QucUNIT_LESS, CorString aMode = "Spline" ) const

double	anIndex
QucUnitType	unitX
QucUnitType	unitY
CorString	aMode

void

setName ( CorString aName )

CorString

aName

CorString

getName () const

QucUnitType

getUnitX () const

QucUnitType

getUnitY () const

int

getSize () const

void

setOutDir ( CorString aDirectory )

CorString

aDirectory

void

writeFile ( CorString aFileName, CorString aType = "Table", CorString aWave = ":WAVE", CorString aFlux = ":FLUX" )

CorString	aFileName
CorString	aType
CorString	aWave
CorString	aFlux

double

getMax () const

double

getMin () const

double

simpsonInt ( double aValue1, double aValue2, int anN = 100 )

double	aValue1
double	aValue2
int	anN

void

scale ( double aFactor )

double

aFactor

void

scaleAt ( double anIndex, QucUnitType aUnit, double aFactor )

double	anIndex
QucUnitType	aUnit
double	aFactor

double

getFirst () const

double

getLast () const

Documentation

SYNOPSIS

#include <QucFunction1D.h> QucFunction1D myObject;
DESCRIPTION
This class serves as a container of an associative array. The values of this array belong to certain units and can be integrated according to the Simpson Intergration.
CAUTIONS
<optional>
EXAMPLES
<optional>
SEE ALSO
<optional>
CorBase
QucUnit

QucFunction1D ( CorString aName = "myframe", int aSize = 1, QucUnitType unitX = QucUNIT_LESS, QucUnitType unitY = QucUNIT_LESS )

Purpose
The default c'tor.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aName: a name
int aSize: size of the array
QucUnitType unitX: a name
QucUnitType unitY: a name

QucFunction1D ( const QucFunction1D & 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 QucFunction1D & aRef: the reference instance

QucFunction1D & operator= ( const QucFunction1D & 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 QucFunction1D & aRef: the reference instance

virtual ~QucFunction1D ()

Purpose
The d'tor.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

void setValue ( int anIndex, double aTuple1, double aTuple2 )

Purpose
Set the value pair at a given index.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

int anIndex: which value pair needs to be changed
double aTuple1: first tuple
double aTuple2: second tuple

void setInDir ( CorString aDirectory )

Purpose
Set the input directory.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aDirectory: new directory path

void readFile ( CorString aFileName, CorString aType = "table", CorString aWave = ":WAVE", CorString aFlux = ":FLUX" )

Purpose
Read the value pairs from a file.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aFileName: file name
CorString aType: what is it we want to read ("file" or "table")
CorString aWave: Name of the table column containing the independent variable (X)
CorString aFlux: Name of the table column containing the dependent variable (Y)

double getX ( int anIndex ) const

Purpose
Query the X value at an index position.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the value of the first tuple at a given index.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

int anIndex: position of tuple

double getY ( int anIndex ) const

Purpose
Query the Y value at an index position.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the value of the second tuple at a given index.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

int anIndex: index of the tuple

double getValueAt ( double anIndex, QucUnitType unitX = QucUNIT_LESS, QucUnitType unitY = QucUNIT_LESS, CorString aMode = "Spline" ) const

Purpose
Query a value at a position through interpolation.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
The interpolated value at a given position.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

double anIndex: position
QucUnitType unitX: unit type of first tuple
QucUnitType unitY: unit tupe of second tuple
CorString aMode: mode of interpolation

void setName ( CorString aName )

Purpose
Set the name of this instance.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aName: new name

CorString getName () const

Purpose
Query the name of this instance.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the name of this instance.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitX () const

Purpose
Query the unit of the first tuple.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit type of the first tuple.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitY () const

Purpose
Query the unit of the second tuple.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit type of the second tuple.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

int getSize () const

Purpose
Query the size of this instance.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the number of elements stored.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

void setOutDir ( CorString aDirectory )

Purpose
Set the output directory.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aDirectory: new directory path

void writeFile ( CorString aFileName, CorString aType = "Table", CorString aWave = ":WAVE", CorString aFlux = ":FLUX" )

Purpose
Write this instance to a file.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aFileName: name of the file
CorString aType: what is it we want to read ("file" or "table")
CorString aWave: Name of the table column containing the independent variable (X)
CorString aFlux: Name of the table column containing the dependent variable (Y)

double getMax () const

Purpose
Query the largest second tuple value.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the largest value held by the Y tuples.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

double getMin () const

Purpose
Query the lowest second tuple value.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the lowest value held by the Y tuples.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

double simpsonInt ( double aValue1, double aValue2, int anN = 100 )

Purpose
Simpson integration.

Preconditions

anN must be even

Returns
This function returns the value of the simpson integration.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aValue1: lower bound of array (start integration here)
double aValue2: upper bound of array (end integration here)
int anN: number of steps (must be even)

void scale ( double aFactor )

Purpose
Scale this instance (its Y values).

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aFactor: scaling factor

void scaleAt ( double anIndex, QucUnitType aUnit, double aFactor )

Purpose
Scale this instance at a specific position for a given unit.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

double anIndex: a position
QucUnitType aUnit: unit
double aFactor: scaling factor

double getFirst () const

Purpose
Query the first Y value of this instance.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the value of the first Y tuple.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

double getLast () const

Purpose
Query the last Y value of this instance.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the value of the last Y tuple.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

void convertUnit ( QucUnitType aUnitX, QucUnitType aUnitY )

Purpose
Convert the tuples from one unit to another.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucUnitType aUnitX: conversion unit for X tuples
QucUnitType aUnitY: conversion unit for Y tuples

void setSize ( int aSize = 1, int aDelete = 1 )

Purpose
Set a new size for this instance.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

int aSize: new size
int aDelete: delete memory if 1

void checkUnitRange ( QucUnitType aUnit, double anotherValue ) const

Purpose
Check the range of a value given a unit.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucUnitType aUnit: unit type to check
double anotherValue: value to check

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++