Class CandleManagerContainer
The standard container that stores candles data.
Namespace: StockSharp.Algo.Candles
Assembly: StockSharp.Algo.dll
Syntax
public class CandleManagerContainer : Disposable, ICandleManagerContainer, IDisposableConstructors
CandleManagerContainer()
Initializes a new instance of the CandleManagerContainer.
Declaration
public CandleManagerContainer()Properties
CandlesKeepTime
Candles storage time in memory. The default is 2 days.
Declaration
public TimeSpan CandlesKeepTime { get; set; }Property Value
| Type | Description |
|---|---|
| TimeSpan |
Remarks
If the value is set to Zero then candles will not be deleted.
Methods
AddCandle(CandleSeries, Candle)
To add a candle for the series.
Declaration
public bool AddCandle(CandleSeries series, Candle candle)Parameters
| Type | Name | Description |
|---|---|---|
| CandleSeries | series | Candles series. |
| Candle | candle | Candle. |
Returns
| Type | Description |
|---|---|
| Boolean | true if the candle is not added previously, otherwise, false. |
DisposeManaged()
Release resources.
Declaration
protected override void DisposeManaged()GetCandle(CandleSeries, Int32)
To get a candle by the index.
Declaration
public Candle GetCandle(CandleSeries series, int candleIndex)Parameters
| Type | Name | Description |
|---|---|---|
| CandleSeries | series | Candles series. |
| Int32 | candleIndex | The candle's position number from the end. |
Returns
| Type | Description |
|---|---|
| Candle | The found candle. If the candle does not exist, then null will be returned. |
GetCandleCount(CandleSeries)
To get the number of candles.
Declaration
public int GetCandleCount(CandleSeries series)Parameters
| Type | Name | Description |
|---|---|---|
| CandleSeries | series | Candles series. |
Returns
| Type | Description |
|---|---|
| Int32 | Number of candles. |
GetCandles(CandleSeries)
To get all associated with the series candles.
Declaration
public IEnumerable<Candle> GetCandles(CandleSeries series)Parameters
| Type | Name | Description |
|---|---|---|
| CandleSeries | series | Candles series. |
Returns
| Type | Description |
|---|---|
| IEnumerable<Candle> | Candles. |
GetCandles(CandleSeries, Range<DateTimeOffset>)
To get candles by the series and date range.
Declaration
public IEnumerable<Candle> GetCandles(CandleSeries series, Range<DateTimeOffset> timeRange)Parameters
| Type | Name | Description |
|---|---|---|
| CandleSeries | series | Candles series. |
| Ecng.ComponentModel.Range<DateTimeOffset> | timeRange | The date range which should include candles. The OpenTime value is taken into consideration. |
Returns
| Type | Description |
|---|---|
| IEnumerable<Candle> | Found candles. |
GetCandles(CandleSeries, DateTimeOffset)
To get all associated with the series candles for the time period.
Declaration
public IEnumerable<Candle> GetCandles(CandleSeries series, DateTimeOffset time)Parameters
| Type | Name | Description |
|---|---|---|
| CandleSeries | series | Candles series. |
| DateTimeOffset | time | The candle period. |
Returns
| Type | Description |
|---|---|
| IEnumerable<Candle> | Candles. |
GetCandles(CandleSeries, Int32)
To get candles by the series and the total number.
Declaration
public IEnumerable<Candle> GetCandles(CandleSeries series, int candleCount)Parameters
| Type | Name | Description |
|---|---|---|
| CandleSeries | series | Candles series. |
| Int32 | candleCount | The number of candles that should be returned. |
Returns
| Type | Description |
|---|---|
| IEnumerable<Candle> | Found candles. |
Start(CandleSeries, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>)
To notify the container about the start of the candles getting for the series.
Declaration
public void Start(CandleSeries series, Nullable<DateTimeOffset> from, Nullable<DateTimeOffset> to)Parameters
| Type | Name | Description |
|---|---|---|
| CandleSeries | series | Candles series. |
| Nullable<DateTimeOffset> | from | The initial date from which the candles will be get. |
| Nullable<DateTimeOffset> | to | The final date by which the candles will be get. |