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

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

#include <qcustomplot.h>

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

double key
 
double open
 
double high
 
double low
 
double close
 

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

Constructor & Destructor Documentation

QCPFinancialData::QCPFinancialData ( )

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

Definition at line 25776 of file qcustomplot.cpp.

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 25788 of file qcustomplot.cpp.

Member Function Documentation

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

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

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

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

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

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

Member Data Documentation

double QCPFinancialData::close

Definition at line 5797 of file qcustomplot.h.

double QCPFinancialData::high

Definition at line 5797 of file qcustomplot.h.

double QCPFinancialData::key

Definition at line 5797 of file qcustomplot.h.

double QCPFinancialData::low

Definition at line 5797 of file qcustomplot.h.

double QCPFinancialData::open

Definition at line 5797 of file qcustomplot.h.

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