dxFeed .Net API  7.1.0
dxFeed .Net API library intended to provide market data access for DX clients
com.dxfeed.api.candle.CandleExchange Class Reference

Exchange attribute of CandleSymbol defines exchange identifier where data is taken from to build the candles. More...

Inheritance diagram for com.dxfeed.api.candle.CandleExchange:
[legend]
Collaboration diagram for com.dxfeed.api.candle.CandleExchange:
[legend]

Public Member Functions

char GetExchangeCode ()
 Returns exchange code. It is `'\0'` for COMPOSITE exchange. More...
 
override string ToString ()
 Returns string representation of this exchange. It is the string "COMPOSITE" for COMPOSITE exchange or exchange character otherwise. More...
 
override bool Equals (object o)
 Indicates whether this exchange attribute is the same as another one. More...
 
override int GetHashCode ()
 Returns hash code of this exchange attribute. More...
 
string ChangeAttributeForSymbol (string symbol)
 Returns candle event symbol string with this exchange set. More...
 
void CheckInAttributeImpl (CandleSymbol candleSymbol)
 Internal method that initializes attribute in the candle symbol. More...
 

Static Public Member Functions

static CandleExchange ValueOf (char exchangeCode)
 Returns exchange attribute object that corresponds to the specified exchange code character. More...
 
static CandleExchange GetAttributeForSymbol (string symbol)
 Returns exchange attribute object of the given candle symbol string. The result is DEFAULT if the symbol does not have exchange attribute. More...
 

Static Public Attributes

static readonly CandleExchange COMPOSITE = new CandleExchange('\0')
 Composite exchange where data is taken from all exchanges. More...
 
static readonly CandleExchange DEFAULT = COMPOSITE
 Default exchange is COMPOSITE. More...
 

Detailed Description

Exchange attribute of CandleSymbol defines exchange identifier where data is taken from to build the candles.

Implementation details

This attribute is encoded in a symbol string with MarketEventSymbols.GetExchangeCode and MarketEventSymbols.ChangeExchangeCode methods.

Member Function Documentation

◆ ChangeAttributeForSymbol()

string com.dxfeed.api.candle.CandleExchange.ChangeAttributeForSymbol ( string  symbol)
inline

Returns candle event symbol string with this exchange set.

Parameters
symboloriginal candle event symbol.
Returns
candle event symbol string with this exchange set.

Implements com.dxfeed.api.candle.ICandleSymbolAttribute.

◆ CheckInAttributeImpl()

void com.dxfeed.api.candle.CandleExchange.CheckInAttributeImpl ( CandleSymbol  candleSymbol)
inline

Internal method that initializes attribute in the candle symbol.

Parameters
candleSymbolcandle symbol.
Exceptions
InvalidOperationExceptionif used outside of internal initialization logic.

Implements com.dxfeed.api.candle.ICandleSymbolAttribute.

◆ Equals()

override bool com.dxfeed.api.candle.CandleExchange.Equals ( object  o)
inline

Indicates whether this exchange attribute is the same as another one.

Parameters
o
Returns
true if this exchange attribute is the same as another one.

◆ GetAttributeForSymbol()

static CandleExchange com.dxfeed.api.candle.CandleExchange.GetAttributeForSymbol ( string  symbol)
inlinestatic

Returns exchange attribute object of the given candle symbol string. The result is DEFAULT if the symbol does not have exchange attribute.

Parameters
symbolcandle symbol string.
Returns
exchange attribute object of the given candle symbol string.

◆ GetExchangeCode()

char com.dxfeed.api.candle.CandleExchange.GetExchangeCode ( )
inline

Returns exchange code. It is `'\0'` for COMPOSITE exchange.

Returns
exchange code.

◆ GetHashCode()

override int com.dxfeed.api.candle.CandleExchange.GetHashCode ( )
inline

Returns hash code of this exchange attribute.

Returns
hash code of this exchange attribute.

◆ ToString()

override string com.dxfeed.api.candle.CandleExchange.ToString ( )
inline

Returns string representation of this exchange. It is the string "COMPOSITE" for COMPOSITE exchange or exchange character otherwise.

Returns
string representation of this exchange.

◆ ValueOf()

static CandleExchange com.dxfeed.api.candle.CandleExchange.ValueOf ( char  exchangeCode)
inlinestatic

Returns exchange attribute object that corresponds to the specified exchange code character.

Parameters
exchangeCodeexchange code character.
Returns
exchange attribute object.

Field Documentation

◆ COMPOSITE

readonly CandleExchange com.dxfeed.api.candle.CandleExchange.COMPOSITE = new CandleExchange('\0')
static

Composite exchange where data is taken from all exchanges.

◆ DEFAULT

readonly CandleExchange com.dxfeed.api.candle.CandleExchange.DEFAULT = COMPOSITE
static

Default exchange is COMPOSITE.


The documentation for this class was generated from the following file: