QwtOHLCSample.3 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. .TH "QwtOHLCSample" 3 "Mon Dec 28 2020" "Version 6.1.6" "Qwt User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtOHLCSample \- Open-High-Low-Close sample used in financial charts\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <qwt_samples\&.h>\fP
  11. .SS "Public Member Functions"
  12. .in +1c
  13. .ti -1c
  14. .RI "\fBQwtOHLCSample\fP (double \fBtime\fP=0\&.0, double \fBopen\fP=0\&.0, double \fBhigh\fP=0\&.0, double \fBlow\fP=0\&.0, double \fBclose\fP=0\&.0)"
  15. .br
  16. .ti -1c
  17. .RI "\fBQwtInterval\fP \fBboundingInterval\fP () const"
  18. .br
  19. .RI "Calculate the bounding interval of the OHLC values\&. "
  20. .ti -1c
  21. .RI "bool \fBisValid\fP () const"
  22. .br
  23. .RI "Check if a sample is valid\&. "
  24. .in -1c
  25. .SS "Public Attributes"
  26. .in +1c
  27. .ti -1c
  28. .RI "double \fBtime\fP"
  29. .br
  30. .ti -1c
  31. .RI "double \fBopen\fP"
  32. .br
  33. .RI "Opening price\&. "
  34. .ti -1c
  35. .RI "double \fBhigh\fP"
  36. .br
  37. .RI "Highest price\&. "
  38. .ti -1c
  39. .RI "double \fBlow\fP"
  40. .br
  41. .RI "Lowest price\&. "
  42. .ti -1c
  43. .RI "double \fBclose\fP"
  44. .br
  45. .RI "Closing price\&. "
  46. .in -1c
  47. .SH "Detailed Description"
  48. .PP
  49. Open-High-Low-Close sample used in financial charts\&.
  50. In financial charts the movement of a price in a time interval is often represented by the opening/closing prices and the lowest/highest prices in this interval\&.
  51. .PP
  52. \fBSee also\fP
  53. .RS 4
  54. \fBQwtTradingChartData\fP
  55. .RE
  56. .PP
  57. .SH "Constructor & Destructor Documentation"
  58. .PP
  59. .SS "QwtOHLCSample::QwtOHLCSample (double t = \fC0\&.0\fP, double o = \fC0\&.0\fP, double h = \fC0\&.0\fP, double l = \fC0\&.0\fP, double c = \fC0\&.0\fP)\fC [inline]\fP"
  60. Constructor
  61. .PP
  62. \fBParameters\fP
  63. .RS 4
  64. \fIt\fP Time value
  65. .br
  66. \fIo\fP Open value
  67. .br
  68. \fIh\fP High value
  69. .br
  70. \fIl\fP Low value
  71. .br
  72. \fIc\fP Close value
  73. .RE
  74. .PP
  75. .SH "Member Function Documentation"
  76. .PP
  77. .SS "\fBQwtInterval\fP QwtOHLCSample::boundingInterval () const\fC [inline]\fP"
  78. .PP
  79. Calculate the bounding interval of the OHLC values\&. For valid samples the limits of this interval are always low/high\&.
  80. .PP
  81. \fBReturns\fP
  82. .RS 4
  83. Bounding interval
  84. .RE
  85. .PP
  86. \fBSee also\fP
  87. .RS 4
  88. \fBisValid()\fP
  89. .RE
  90. .PP
  91. .SS "bool QwtOHLCSample::isValid () const\fC [inline]\fP"
  92. .PP
  93. Check if a sample is valid\&. A sample is valid, when all of the following checks are true:
  94. .PP
  95. .IP "\(bu" 2
  96. low <= high
  97. .IP "\(bu" 2
  98. low <= open <= high
  99. .IP "\(bu" 2
  100. low <= close <= high
  101. .PP
  102. .PP
  103. \fBReturns\fP
  104. .RS 4
  105. True, when the sample is valid
  106. .RE
  107. .PP
  108. .SH "Member Data Documentation"
  109. .PP
  110. .SS "double QwtOHLCSample::time"
  111. Time of the sample, usually a number representing a specific interval - like a day\&.
  112. .SH "Author"
  113. .PP
  114. Generated automatically by Doxygen for Qwt User's Guide from the source code\&.