QCPFinancialData

Search for usage in LXR

Public Member Functions

 QCPFinancialData ()
 
 QCPFinancialData (double key, double open, double high, double low, double close)
 
double mainKey () const
 
double mainValue () const
 
double sortKey () const
 
QCPRange valueRange () const
 

Static Public Member Functions

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

Public Attributes

double close
 
double high
 
double key
 
double low
 
double open
 

Detailed Description

Holds the data of one single data point for QCPFinancial.

The stored data is:

  • key: coordinate on the key axis of this data point (this is the mainKey and the sortKey)
  • open: The opening value at the data point (this is the mainValue)
  • high: The high/maximum value at the data point
  • low: The low/minimum value at the data point
  • close: The closing value at the data point

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

See also
QCPFinancialDataContainer

Definition at line 6158 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPFinancialData() [1/2]

QCPFinancialData::QCPFinancialData ( )

Constructs a data point with key and all values set to zero.

Definition at line 27004 of file qcustomplot.cpp.

◆ QCPFinancialData() [2/2]

QCPFinancialData::QCPFinancialData ( double key,
double open,
double high,
double low,
double close )

Constructs a data point with the specified key and OHLC values.

Definition at line 27016 of file qcustomplot.cpp.

Member Function Documentation

◆ fromSortKey()

static QCPFinancialData QCPFinancialData::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 6165 of file qcustomplot.h.

◆ mainKey()

double QCPFinancialData::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 6168 of file qcustomplot.h.

◆ mainValue()

double QCPFinancialData::mainValue ( ) const
inline

Returns the open 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 6169 of file qcustomplot.h.

◆ sortKey()

double QCPFinancialData::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 6164 of file qcustomplot.h.

◆ sortKeyIsMainKey()

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

◆ valueRange()

QCPRange QCPFinancialData::valueRange ( ) const
inline

Returns a QCPRange spanning from the low to the high 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 6171 of file qcustomplot.h.

Member Data Documentation

◆ close

double QCPFinancialData::close

Definition at line 6173 of file qcustomplot.h.

◆ high

double QCPFinancialData::high

Definition at line 6173 of file qcustomplot.h.

◆ key

double QCPFinancialData::key

Definition at line 6173 of file qcustomplot.h.

◆ low

double QCPFinancialData::low

Definition at line 6173 of file qcustomplot.h.

◆ open

double QCPFinancialData::open

Definition at line 6173 of file qcustomplot.h.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 4 2024 16:38:45 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.