Lean  $LEAN_TAG$
CandleEnums.cs
1 /*
2  * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
3  * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14 */
15 
16 namespace QuantConnect.Indicators.CandlestickPatterns
17 {
18  /// <summary>
19  /// Types of candlestick settings
20  /// </summary>
21  public enum CandleSettingType
22  {
23  /// <summary>
24  /// Real body is long when it's longer than the average of the 10 previous candles' real body (0)
25  /// </summary>
26  BodyLong,
27 
28  /// <summary>
29  /// Real body is very long when it's longer than 3 times the average of the 10 previous candles' real body (1)
30  /// </summary>
31  BodyVeryLong,
32 
33  /// <summary>
34  /// Real body is short when it's shorter than the average of the 10 previous candles' real bodies (2)
35  /// </summary>
36  BodyShort,
37 
38  /// <summary>
39  /// Real body is like doji's body when it's shorter than 10% the average of the 10 previous candles' high-low range (3)
40  /// </summary>
41  BodyDoji,
42 
43  /// <summary>
44  /// Shadow is long when it's longer than the real body (4)
45  /// </summary>
46  ShadowLong,
47 
48  /// <summary>
49  /// Shadow is very long when it's longer than 2 times the real body (5)
50  /// </summary>
51  ShadowVeryLong,
52 
53  /// <summary>
54  /// Shadow is short when it's shorter than half the average of the 10 previous candles' sum of shadows (6)
55  /// </summary>
56  ShadowShort,
57 
58  /// <summary>
59  /// Shadow is very short when it's shorter than 10% the average of the 10 previous candles' high-low range (7)
60  /// </summary>
61  ShadowVeryShort,
62 
63  /// <summary>
64  /// When measuring distance between parts of candles or width of gaps
65  /// "near" means "&lt;= 20% of the average of the 5 previous candles' high-low range" (8)
66  /// </summary>
67  Near,
68 
69  /// <summary>
70  /// When measuring distance between parts of candles or width of gaps
71  /// "far" means "&gt;= 60% of the average of the 5 previous candles' high-low range" (9)
72  /// </summary>
73  Far,
74 
75  /// <summary>
76  /// When measuring distance between parts of candles or width of gaps
77  /// "equal" means "&lt;= 5% of the average of the 5 previous candles' high-low range" (10)
78  /// </summary>
79  Equal
80  }
81 
82  /// <summary>
83  /// Types of candlestick ranges
84  /// </summary>
85  public enum CandleRangeType
86  {
87  /// <summary>
88  /// The part of the candle between open and close (0)
89  /// </summary>
90  RealBody,
91 
92  /// <summary>
93  /// The complete range of the candle (1)
94  /// </summary>
95  HighLow,
96 
97  /// <summary>
98  /// The shadows (or tails) of the candle (2)
99  /// </summary>
100  Shadows
101  }
102 
103  /// <summary>
104  /// Colors of a candle
105  /// </summary>
106  public enum CandleColor
107  {
108  /// <summary>
109  /// White is an up candle (close higher or equal than open) (1)
110  /// </summary>
111  White = 1,
112 
113  /// <summary>
114  /// Black is a down candle (close lower than open) (-1)
115  /// </summary>
116  Black = -1
117  }
118 }