Table of Contents

Class Candle

Namespace
StockSharp.Algo.Candles
Assembly
StockSharp.BusinessEntities.dll

Base candle class (contains main parameters).

[DataContract]
[KnownType(typeof(TickCandle))]
[KnownType(typeof(VolumeCandle))]
[KnownType(typeof(RangeCandle))]
[KnownType(typeof(TimeFrameCandle))]
[KnownType(typeof(PnFCandle))]
[KnownType(typeof(RenkoCandle))]
[Obsolete("Use ICandleMessage.")]
public abstract class Candle : Cloneable<Candle>, ICandleMessage, ISecurityIdMessage, ISeqNumMessage, IGeneratedMessage, ILocalTimeMessage, IServerTimeMessage
Inheritance
Candle
Implements
Derived
Extension Methods

Constructors

Candle()

Initializes a new instance of the Candle.

protected Candle()

Properties

Arg

public abstract object Arg { get; set; }

Property Value

object

ArgType

Type of argument.

public abstract Type ArgType { get; }

Property Value

Type

BuildFrom

Determines the message is generated from the specified DataType.

[DataMember]
public DataType BuildFrom { get; set; }

Property Value

DataType

BuyVolume

Buy volume.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "BuyVolume", Description = "BuyVolume", GroupName = "General")]
public decimal? BuyVolume { get; set; }

Property Value

decimal?

ClosePrice

Closing price.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "ClosingPrice", Description = "ClosePriceOfCandle", GroupName = "General")]
public decimal ClosePrice { get; set; }

Property Value

decimal

CloseTime

Close time.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "CandleCloseTime", Description = "CandleCloseTime", GroupName = "General")]
public DateTimeOffset CloseTime { get; set; }

Property Value

DateTimeOffset

CloseVolume

Volume at close.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "CloseVolume", Description = "CloseVolume", GroupName = "General")]
public decimal? CloseVolume { get; set; }

Property Value

decimal?

DataType

public DataType DataType { get; set; }

Property Value

DataType

DownTicks

Number of down trending ticks.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "TickDown", Description = "TickDownCount", GroupName = "General")]
public int? DownTicks { get; set; }

Property Value

int?

HighPrice

Highest price.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "HighestPrice", Description = "HighPriceOfCandle", GroupName = "General")]
public decimal HighPrice { get; set; }

Property Value

decimal

HighTime

High time.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "CandleHighTime", Description = "CandleHighTime", GroupName = "General")]
public DateTimeOffset HighTime { get; set; }

Property Value

DateTimeOffset

HighVolume

Volume at high.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "HighVolume", Description = "HighVolume", GroupName = "General")]
public decimal? HighVolume { get; set; }

Property Value

decimal?

LowPrice

Lowest price.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "LowestPrice", Description = "LowPriceOfCandle", GroupName = "General")]
public decimal LowPrice { get; set; }

Property Value

decimal

LowTime

Low time.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "CandleLowTime", Description = "CandleLowTime", GroupName = "General")]
public DateTimeOffset LowTime { get; set; }

Property Value

DateTimeOffset

LowVolume

Volume at low.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "LowVolume", Description = "LowVolume", GroupName = "General")]
public decimal? LowVolume { get; set; }

Property Value

decimal?

OpenInterest

Open interest.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "OI", Description = "OpenInterestDesc", GroupName = "General")]
public decimal? OpenInterest { get; set; }

Property Value

decimal?

OpenPrice

Opening price.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "OpenPrice", Description = "CandleOpenPrice", GroupName = "General")]
public decimal OpenPrice { get; set; }

Property Value

decimal

OpenTime

Open time.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "CandleOpenTime", Description = "CandleOpenTime", GroupName = "General")]
public DateTimeOffset OpenTime { get; set; }

Property Value

DateTimeOffset

OpenVolume

Volume at open.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "OpenVolume", Description = "OpenVolume", GroupName = "General")]
public decimal? OpenVolume { get; set; }

Property Value

decimal?

PriceLevels

Price levels.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "PriceLevels", Description = "PriceLevels", GroupName = "General")]
public IEnumerable<CandlePriceLevel> PriceLevels { get; set; }

Property Value

IEnumerable<CandlePriceLevel>

RelativeVolume

Relative volume.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "RelativeVolume", Description = "RelativeVolume", GroupName = "General")]
public decimal? RelativeVolume { get; set; }

Property Value

decimal?

Security

Security.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "Security", Description = "Security", GroupName = "General")]
public Security Security { get; set; }

Property Value

Security

SellVolume

Sell volume.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "SellVolume", Description = "SellVolume", GroupName = "General")]
public decimal? SellVolume { get; set; }

Property Value

decimal?

SeqNum

Sequence number.

[DataMember]
public long SeqNum { get; set; }

Property Value

long

Remarks

Zero means no information.

State

State.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "State", Description = "CandleState", GroupName = "General")]
public CandleStates State { get; set; }

Property Value

CandleStates

TotalPrice

Total price size.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "TotalPrice", Description = "TotalPrice", GroupName = "General")]
public decimal TotalPrice { get; set; }

Property Value

decimal

TotalTicks

Number of ticks.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "Ticks", Description = "TickCount", GroupName = "General")]
public int? TotalTicks { get; set; }

Property Value

int?

TotalVolume

Total volume.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "Volume", Description = "TotalCandleVolume", GroupName = "General")]
public decimal TotalVolume { get; set; }

Property Value

decimal

UpTicks

Number of up trending ticks.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "TickUp", Description = "TickUpCount", GroupName = "General")]
public int? UpTicks { get; set; }

Property Value

int?

Methods

CopyTo<TCandle>(TCandle)

Copy the message into the destination.

protected TCandle CopyTo<TCandle>(TCandle destination) where TCandle : Candle

Parameters

destination TCandle

The object, to which copied information.

Returns

TCandle

The object, to which copied information.

Type Parameters

TCandle

The candle type.

ToString()

public override string ToString()

Returns

string