MLCurveDataWrapper Class Reference

#include <mlCurveDataWrapper.h>

Inherits MLRefCountedBaseWrapper.

Properties
int	curveStyle
QString	curveSymbol
QString	curveTitle
int	curveType
QString	curveUnit
int	numPoints
int	numSeries

Detailed Description

A class that wraps CurveData objects for use in Python.

Member Function Documentation

clear

void MLCurveDataWrapper::clear ( )

slot

Clears curve data and reset curve properties.

clearData

void MLCurveDataWrapper::clearData ( )

slot

Clears curve data.

getCurveStyle

int MLCurveDataWrapper::getCurveStyle ( ) const

slot

Returns the curve style.

getCurveSymbol

QString MLCurveDataWrapper::getCurveSymbol ( ) const

slot

Returns the curve symbol.

getCurveTitle

QString MLCurveDataWrapper::getCurveTitle ( ) const

slot

Returns the curve title.

getCurveType

int MLCurveDataWrapper::getCurveType ( ) const

slot

Returns the curve type.

getCurveUnit

QString MLCurveDataWrapper::getCurveUnit ( ) const

slot

Returns the curve unit.

getNumPoints

int MLCurveDataWrapper::getNumPoints ( ) const

slot

Returns the number of points in the curve.

getNumSeries

int MLCurveDataWrapper::getNumSeries ( ) const

slot

Returns the number of series in the curve.

getXMax

double MLCurveDataWrapper::getXMax ( ) const

slot

Returns the maxium X value.

getXMin

double MLCurveDataWrapper::getXMin ( ) const

slot

Returns the minimum X value.

getXSlice

QList< double > MLCurveDataWrapper::getXSlice ( int  startPoint, int  endPoint = -1  )

slot

Returns slice of X values from startPoint to endPoint (inclusive!).

If endPoint is omitted, it is assumed to be the last point of the curve.

getXSpacing

QList< double > MLCurveDataWrapper::getXSpacing ( ) const

slot

Returns spacing of X values.

getXValue

double MLCurveDataWrapper::getXValue ( int  point ) const

slot

Returns the X value at point.

getXValues

QList< double > MLCurveDataWrapper::getXValues ( ) const

slot

Returns all X values.

getYMax

double MLCurveDataWrapper::getYMax ( ) const

slot

Returns the maximum Y value.

getYMin

double MLCurveDataWrapper::getYMin ( ) const

slot

Returns the minimum Y value.

getYSlice

QList< double > MLCurveDataWrapper::getYSlice ( int  startPoint, int  endPoint = -1, int  series = 0  )

slot

Returns slice of Y values from startPoint to endPoint (inclusive!) in series.

If series is omitted, series 0 is assumed. If endPoint is omitted, it is assumed to be the last point of the curve.

getYValue

double MLCurveDataWrapper::getYValue ( int  point, int  series = 0  ) const

slot

Returns the Y value at point in series.

If series is omitted, series 0 is assumed.

getYValues

QList< double > MLCurveDataWrapper::getYValues ( int  series = 0 ) const

slot

Returns all Y values for a given series.

resizeX

void MLCurveDataWrapper::resizeX ( int  nPoints )

slot

Changes length of X-series. New values are initialized to zero.

resizeY [1/2]

void MLCurveDataWrapper::resizeY ( int  iSeries, int  nPoints  )

slot

Changes length of iSeries-th Y-series. New values are initialized to zero.

resizeY [2/2]

void MLCurveDataWrapper::resizeY ( int  nPoints )

slot

Changes length of first Y-series. New values are initialized to zero.

setAutoXRange

void MLCurveDataWrapper::setAutoXRange ( )

slot

Sets X value range to 'automatic', i.e. dependent on X series data.

setAutoYRange

void MLCurveDataWrapper::setAutoYRange ( )

slot

Sets Y value range to 'automatic', i.e. dependent on Y series data.

setCurveStyle

void MLCurveDataWrapper::setCurveStyle ( int  curveStyle )

slot

Sets the curve style.

setCurveSymbol

void MLCurveDataWrapper::setCurveSymbol ( QString  curveSymbol )

slot

Sets the curve symbol.

setCurveTitle

void MLCurveDataWrapper::setCurveTitle ( QString  curveTitle )

slot

Sets the curve title.

setCurveType

void MLCurveDataWrapper::setCurveType ( int  curveType )

slot

Sets the curve type.

setCurveUnit

void MLCurveDataWrapper::setCurveUnit ( QString  curveUnit )

slot

Sets the curve unit.

setX

void MLCurveDataWrapper::setX ( int  nPoints, QList< double >  data, int  step = 1  )

slot

Sets X-series to nPoints double values copied from the source array data.

The optional step value specifies the array index difference between two consecutive X-series values. Hence, the data array is expected to contain at least (nPoints-1)*step+1 values. If no X data is specified, the X values are generated automatically as numbers 0, 1, ...

setXRange

void MLCurveDataWrapper::setXRange ( double  xMin, double  xMax  )

slot

Explicitly sets X value range to xMin ... xMax.

setXValue

void MLCurveDataWrapper::setXValue ( int  point, double  value  )

slot

Sets the X value at point to value.

setY

void MLCurveDataWrapper::setY ( int  nPoints, QList< double >  data, int  step = 1  )

slot

Sets Y data to a single series of nPoints double values copied from the source array data.

All previous Y-series are replaced by the new series. The optional step value specifies the array index difference between two consecutive Y-series values. Hence, the data array is expected to contain at least (nPoints-1)*step+1 values.

setYRange

void MLCurveDataWrapper::setYRange ( double  yMin, double  yMax  )

slot

Explicitly sets Y value range to yMin ... yMax.

setYValue

void MLCurveDataWrapper::setYValue ( int  point, double  value, int  series = 0  )

slot

Sets Y value at point in series to value.

If series is omitted, series 0 is assumed.

Property Documentation

curveStyle

int MLCurveDataWrapper::curveStyle

readwrite

Style of curve.

curveSymbol

QString MLCurveDataWrapper::curveSymbol

readwrite

Symbol of curve.

curveTitle

QString MLCurveDataWrapper::curveTitle

readwrite

Title of curve.

curveType

int MLCurveDataWrapper::curveType

readwrite

Type of curve.

curveUnit

QString MLCurveDataWrapper::curveUnit

readwrite

Unit of curve.

numPoints

int MLCurveDataWrapper::numPoints

read

Number of points.

numSeries

int MLCurveDataWrapper::numSeries

read

Number of series.