SimCenterCommon
Common functionality used within different SimCenter projects
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
QCPCurveData Class Reference

Holds the data of one single data point for QCPCurve. More...

#include <qcustomplot.h>

Public Member Functions

 QCPCurveData ()
 
 QCPCurveData (double t, double key, double value)
 
double sortKey () const
 
double mainKey () const
 
double mainValue () const
 
QCPRange valueRange () const
 

Static Public Member Functions

static QCPCurveData fromSortKey (double sortKey)
 
static bool sortKeyIsMainKey ()
 

Public Attributes

double t
 
double key
 
double value
 

Detailed Description

Holds the data of one single data point for QCPCurve.

The stored data is:

  • t: the free ordering parameter of this curve point, like in the mathematical vector (x(t), y(t)). (This is the sortKey)
  • key: coordinate on the key axis of this curve point (this is the mainKey)
  • value: coordinate on the value axis of this curve point (this is the mainValue)

The container for storing multiple data points is QCPCurveDataContainer. It is a typedef for QCPDataContainer with QCPCurveData as the DataType template parameter. See the documentation there for an explanation regarding the data type's generic methods.

See also
QCPCurveDataContainer

Definition at line 5226 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPCurveData::QCPCurveData ( )

Constructs a curve data point with t, key and value set to zero.

Definition at line 21412 of file qcustomplot.cpp.

QCPCurveData::QCPCurveData ( double  t,
double  key,
double  value 
)

Constructs a curve data point with the specified t, key and value.

Definition at line 21422 of file qcustomplot.cpp.

Member Function Documentation

static QCPCurveData QCPCurveData::fromSortKey ( double  sortKey)
inlinestatic

Returns a data point with the specified sortKey (assigned to the data point's t member). All other members are set to zero.

For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.

Definition at line 5233 of file qcustomplot.h.

double QCPCurveData::mainKey ( ) const
inline

Returns the key member of this data point.

For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.

Definition at line 5236 of file qcustomplot.h.

double QCPCurveData::mainValue ( ) const
inline

Returns the value member of this data point.

For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.

Definition at line 5237 of file qcustomplot.h.

double QCPCurveData::sortKey ( ) const
inline

Returns the t member of this data point.

For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.

Definition at line 5232 of file qcustomplot.h.

static static bool QCPCurveData::sortKeyIsMainKey ( )
inlinestatic

Since the member key is the data point key coordinate and the member t is the data ordering parameter, this method returns false.

For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.

Definition at line 5234 of file qcustomplot.h.

QCPRange QCPCurveData::valueRange ( ) const
inline

Returns a QCPRange with both lower and upper boundary set to value of this data point.

For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.

Definition at line 5239 of file qcustomplot.h.

Member Data Documentation

double QCPCurveData::key

Definition at line 5241 of file qcustomplot.h.

double QCPCurveData::t

Definition at line 5241 of file qcustomplot.h.

double QCPCurveData::value

Definition at line 5241 of file qcustomplot.h.

The documentation for this class was generated from the following files: