SimCenterCommon
Common functionality used within different SimCenter projects
QCPBarsData Class Reference

Holds the data of one single data point (one bar) for QCPBars. More...

#include <qcustomplot.h>

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

double key
 
double value
 

Detailed Description

Holds the data of one single data point (one bar) for QCPBars.

The stored data is:

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

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

See also
QCPBarsDataContainer

Definition at line 5406 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPBarsData::QCPBarsData ( )

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

Definition at line 23147 of file qcustomplot.cpp.

QCPBarsData::QCPBarsData ( double  key,
double  value 
)

Constructs a bar data point with the specified key and value.

Definition at line 23156 of file qcustomplot.cpp.

Member Function Documentation

static QCPBarsData QCPBarsData::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 5413 of file qcustomplot.h.

double QCPBarsData::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 5416 of file qcustomplot.h.

double QCPBarsData::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 5417 of file qcustomplot.h.

double QCPBarsData::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 5412 of file qcustomplot.h.

static static bool QCPBarsData::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 5414 of file qcustomplot.h.

QCPRange QCPBarsData::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 5419 of file qcustomplot.h.

Member Data Documentation

double QCPBarsData::key

Definition at line 5421 of file qcustomplot.h.

double QCPBarsData::value

Definition at line 5421 of file qcustomplot.h.


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