Price type attribute of CandleSymbol defines price that is used to build the candles.
More...
|
int | GetId () |
| Get id of price type attribute More...
|
|
string | ChangeAttributeForSymbol (string symbol) |
| Returns candle event symbol string with this candle price type set. More...
|
|
void | CheckInAttributeImpl (CandleSymbol candleSymbol) |
| Internal method that initializes attribute in the candle symbol. More...
|
|
override string | ToString () |
| Returns string representation of this candle price type. The string representation of candle price type is a lower case string that corresponds to its type name. For example, LAST is represented as "last". More...
|
|
string | ToFullString () |
| Returns full string representation of this candle price type. It is contains attribute key and its value. The full string representation of LAST is "price=last" More...
|
|
Price type attribute of CandleSymbol defines price that is used to build the candles.
Implementation details
This attribute is encoded in a symbol string with MarketEventSymbols.GetAttributeStringByKey, MarketEventSymbols.ChangeAttributeStringByKey, and MarketEventSymbols.RemoveAttributeStringByKey methods. The key to use with these methods is available via ATTRIBUTE_KEY constant. The value that this key shall be set to is equal to the corresponding CandlePrice.ToString()
◆ CandlePriceType
Enumerator |
---|
Last | |
Bid | |
Ask | |
Mark | |
Settlement | |
◆ CandlePrice()
com.dxfeed.api.candle.CandlePrice.CandlePrice |
( |
CandlePriceType |
priceType, |
|
|
string |
value |
|
) |
| |
|
inlineprivate |
◆ ChangeAttributeForSymbol()
string com.dxfeed.api.candle.CandlePrice.ChangeAttributeForSymbol |
( |
string |
symbol | ) |
|
|
inline |
Returns candle event symbol string with this candle price type set.
- Parameters
-
symbol | original candle event symbol. |
- Returns
- candle event symbol string with this candle price type set.
Implements com.dxfeed.api.candle.ICandleSymbolAttribute.
◆ CheckInAttributeImpl()
void com.dxfeed.api.candle.CandlePrice.CheckInAttributeImpl |
( |
CandleSymbol |
candleSymbol | ) |
|
|
inline |
Internal method that initializes attribute in the candle symbol.
- Parameters
-
candleSymbol | candle symbol. |
- Exceptions
-
InvalidOperationException | if used outside of internal initialization logic. |
Implements com.dxfeed.api.candle.ICandleSymbolAttribute.
◆ GetAttributeForSymbol()
static CandlePrice com.dxfeed.api.candle.CandlePrice.GetAttributeForSymbol |
( |
string |
symbol | ) |
|
|
inlinestatic |
Returns candle price type of the given candle symbol string. The result is DEFAULT if the symbol does not have candle price attribute.
- Parameters
-
symbol | candle symbol string. |
- Returns
- candle price of the given candle symbol string.
◆ GetId()
int com.dxfeed.api.candle.CandlePrice.GetId |
( |
| ) |
|
|
inline |
Get id of price type attribute
- Returns
- id of price type attribute
◆ NormalizeAttributeForSymbol()
static string com.dxfeed.api.candle.CandlePrice.NormalizeAttributeForSymbol |
( |
string |
symbol | ) |
|
|
inlinestatic |
Returns candle symbol string with the normalized representation of the candle price type attribute.
- Parameters
-
symbol | candle symbol string. |
- Returns
- candle symbol string with the normalized representation of the the candle price type attribute.
◆ Parse()
static CandlePrice com.dxfeed.api.candle.CandlePrice.Parse |
( |
string |
s | ) |
|
|
inlinestatic |
Parses string representation of candle price type into object. Any string that was returned by ToString() can be parsed and case is ignored for parsing.
- Parameters
-
s | string representation of candle price type. |
- Returns
- candle price type.
- Exceptions
-
InvalidOperationException | if the string representation is invalid. |
◆ ToFullString()
string com.dxfeed.api.candle.CandlePrice.ToFullString |
( |
| ) |
|
|
inline |
Returns full string representation of this candle price type. It is contains attribute key and its value. The full string representation of LAST is "price=last"
- Returns
◆ ToString()
override string com.dxfeed.api.candle.CandlePrice.ToString |
( |
| ) |
|
|
inline |
Returns string representation of this candle price type. The string representation of candle price type is a lower case string that corresponds to its type name. For example, LAST is represented as "last".
- Returns
- string representation of this candle price type.
◆ ASK
◆ ATTRIBUTE_KEY
readonly string com.dxfeed.api.candle.CandlePrice.ATTRIBUTE_KEY = "price" |
|
static |
The attribute key that is used to store the value of CandlePrice
in a symbol string using methods of MarketEventSymbols class. The value of this constant is "price". The value that this key shall be set to is equal to the corresponding CandlePrice.ToString()
◆ BID
◆ DEFAULT
Default price type is LAST.
◆ LAST
◆ MARK
Market price defined as average between quote bid and ask prices.
◆ objCash
Dictionary<string, CandlePrice> com.dxfeed.api.candle.CandlePrice.objCash = new Dictionary<string, CandlePrice>() |
|
staticprivate |
◆ priceType
◆ SETTLEMENT
◆ value
readonly string com.dxfeed.api.candle.CandlePrice.value |
|
private |
The documentation for this class was generated from the following file: