SimCenterCommon
Common functionality used within different SimCenter projects
QCPGraphData Class Reference

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

#include <qcustomplot.h>

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

double key
 
double value
 

Detailed Description

Holds the data of one single data point for QCPGraph.

The stored data is:

  • key: coordinate on the key axis of this data point (this is the mainKey and the sortKey)
  • value: coordinate on the value axis of this data point (this is the mainValue)

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

See also
QCPGraphDataContainer

Definition at line 5088 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPGraphData::QCPGraphData ( )

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

Definition at line 19702 of file qcustomplot.cpp.

QCPGraphData::QCPGraphData ( double  key,
double  value 
)

Constructs a data point with the specified key and value.

Definition at line 19711 of file qcustomplot.cpp.

Member Function Documentation

static QCPGraphData QCPGraphData::fromSortKey ( double  sortKey)
inlinestatic

Returns a data point with the specified sortKey. 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 5095 of file qcustomplot.h.

double QCPGraphData::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 5098 of file qcustomplot.h.

double QCPGraphData::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 5099 of file qcustomplot.h.

double QCPGraphData::sortKey ( ) 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 5094 of file qcustomplot.h.

static static bool QCPGraphData::sortKeyIsMainKey ( )
inlinestatic

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

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 5096 of file qcustomplot.h.

QCPRange QCPGraphData::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 5101 of file qcustomplot.h.

Member Data Documentation

double QCPGraphData::key

Definition at line 5103 of file qcustomplot.h.

double QCPGraphData::value

Definition at line 5103 of file qcustomplot.h.


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