class QucFunction1D : public CorPersistent

a two dimensional array of assiciated values

Inheritance:

Public Methods

void checkUnitRange ( QucUnitType aUnit, double anotherValue )
double getFirst ()
double getLast ()
double getMax ()
double getMin ()
RWCString getName ()
int getSize ()
QucUnitType getUnitX ()
QucUnitType getUnitY ()
virtual double getValueAt ( double anIndex, QucUnitType unitX = QucUNIT_LESS, QucUnitType unitY = QucUNIT_LESS, const RWCString& aMode = "Spline" )
double getX ( int anIndex )
const double* getXStart ()
double getY ( int anIndex )
double* getYStart ()
const double* getYStart ()
CorBool isSet ( int anIndex )
virtual CorPersistent* makeClone ()
QucFunction1D& operator= ( const QucFunction1D& aRef )
QucFunction1D ( const RWCString& aName = "myframe", int aSize = 1, QucUnitType unitX = QucUNIT_LESS, QucUnitType unitY = QucUNIT_LESS )
QucFunction1D ( const QucFunction1D& aRef )
void readFile ( const RWCString& aFileName, const RWCString& aType = "table", const RWCString& aWave = ":WAVE", const RWCString& aFlux = ":FLUX" )
void scale ( double aFactor )
void scaleAt ( double anIndex, QucUnitType aUnit, double aFactor )
void setInDir ( const RWCString& aDirectory )
void setName ( const RWCString& aName )
void setOutDir ( const RWCString& aDirectory )
void setValue ( int anIndex, double aTuple1, double aTuple2 )
double simpsonInt ( double aValue1, double aValue2, int anN = 100 )
virtual void stream ( CorStream& aStream )
double trapezeInt ( double aValue1, double aValue2, int anN = 100 )
void writeFile ( const RWCString& aFileName, const RWCString& aType = "Table", const RWCString& aWave = ":WAVE", const RWCString& aFlux = ":FLUX" )
virtual ~QucFunction1D ()

Public


Purpose
Query the size of this instance

Purpose
Query the last Y value of this instance

Purpose
The d'tor

Purpose
Query the name of this instance

Purpose
Query the unit of the first tuple

Purpose
Query the unit of the second tuple

$Id: QucFunction1D

Purpose
Query the largest second tuple value

Purpose
Query the lowest second tuple value

Purpose
Query the first Y value of this instance

Protected Methods

double* getXStart ()

Protected


Purpose
Query the address of the first Y value

Purpose
Query the address of the first Y value

Purpose
Query the address of the first X value

Purpose
Make a clone of this instance

Purpose
Query the address of the first X value

Private Fields

RWCString mName
Purpose
Set the minimum and maximum values of this instance

Private Methods

void convertUnit ( QucUnitType aUnitX, QucUnitType aUnitY )
void setMinMax ()
void setSize ( int aSize = 1, int aDelete = 1 )

Documentation

a two dimensional array of assiciated values
$Id: QucFunction1D.h,v 1.9 1997/04/11 14:10:57 mwiedmer Exp $

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.

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
<optional>
CorBase
QucUnit

QucFunction1D( const RWCString& aName = "myframe", int aSize = 1, QucUnitType unitX = QucUNIT_LESS, QucUnitType unitY = QucUNIT_LESS )

QucFunction1D( const QucFunction1D& aRef )

QucFunction1D& operator=( const QucFunction1D& aRef )

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 )

void setInDir( const RWCString& aDirectory )

void readFile( const RWCString& aFileName, const RWCString& aType = "table", const RWCString& aWave = ":WAVE", const RWCString& aFlux = ":FLUX" )

double getX( int anIndex )

double getY( int anIndex )

virtual double getValueAt( double anIndex, QucUnitType unitX = QucUNIT_LESS, QucUnitType unitY = QucUNIT_LESS, const RWCString& aMode = "Spline" )

void setName( const RWCString& aName )

RWCString getName()

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()

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()

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()

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( const RWCString& aDirectory )

void writeFile( const RWCString& aFileName, const RWCString& aType = "Table", const RWCString& aWave = ":WAVE", const RWCString& aFlux = ":FLUX" )

double getMax()

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()

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 )

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

void scale( double aFactor )

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

double getFirst()

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()

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.

virtual void stream( CorStream& aStream )

virtual CorPersistent* makeClone()

Purpose
Make a clone of this instance.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function retutns a pointer to a newly created instance that has the same properties as this one.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

CorBool isSet( int anIndex )

double* getXStart()

Purpose
Query the address of the first X value.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the address of the first X value.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

double* getYStart()

Purpose
Query the address of the first Y value.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

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

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

const double* getXStart()

Purpose
Query the address of the first X value.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the address of the first X value.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

const double* getYStart()

Purpose
Query the address of the first Y value.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

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

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

void checkUnitRange( QucUnitType aUnit, double anotherValue )

void convertUnit( QucUnitType aUnitX, QucUnitType aUnitY )

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

void setMinMax()

RWCString mName
Purpose
Set the minimum and maximum values of this instance.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

Direct child classes:
QucDiscontinuousFunction1D
QucContinuousFunction1D

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de