Class CandleSymbol

Namespace

DxFeed.Graal.Net.Events.Candles

Assembly

DxFeed.Graal.Net.dll

Symbol that should be used with DXFeedSubscription class to subscribe for Candle events. DXFeedSubscription also accepts a string representation of the candle symbol for subscription.
For more details see Javadoc.

public class CandleSymbol

Inheritance

object

CandleSymbol

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

Alignment

Gets alignment attribute of this symbol.

public CandleAlignment? Alignment { get; }

Property Value

CandleAlignment

BaseSymbol

Gets base market symbol without attributes.

public string? BaseSymbol { get; }

Property Value

string

Exchange

Gets exchange attribute of this symbol.

public CandleExchange? Exchange { get; }

Property Value

CandleExchange

Period

Gets aggregation period of this symbol.

public CandlePeriod? Period { get; }

Property Value

CandlePeriod

Price

Gets price type attribute of this symbol.

public CandlePrice? Price { get; }

Property Value

CandlePrice

PriceLevel

Gets price level attribute of this symbol.

public CandlePriceLevel? PriceLevel { get; }

Property Value

CandlePriceLevel

Session

Gets session attribute of this symbol.

public CandleSession? Session { get; }

Property Value

CandleSession

Symbol

Returns string representation of this symbol. The string representation can be transformed back into symbol object using ValueOf(string?) method.

public string? Symbol { get; }

Property Value

string

The string representation.

Methods

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Returns a hash code value for this symbol.

public override int GetHashCode()

Returns

int

A hash code value for this symbol.

ToString()

Returns string representation of this symbol. The string representation can be transformed back into symbol object using ValueOf(string?) method.

public override string ToString()

Returns

string

The string representation.

ValueOf(string?)

Converts the given string symbol into the candle symbol object.

public static CandleSymbol ValueOf(string? symbol)

Parameters

symbol string

The string symbol.

Returns

CandleSymbol

The candle symbol object.

Exceptions

ArgumentException

If the string does not represent a valid symbol.

ValueOf(string?, params ICandleSymbolProperty[])

Converts the given string symbol into the candle symbol object with the specified attribute set.

public static CandleSymbol ValueOf(string? symbol, params ICandleSymbolProperty[] attributes)

Parameters

symbol string

The string symbol.

attributes ICandleSymbolProperty[]

The attributes to set.

Returns

CandleSymbol

The candle symbol object.

Exceptions

ArgumentException

If the string does not represent a valid symbol.