dxFeed .Net API  5.13.0
dxFeed .Net API library intended to provide market data access for DX clients
Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes
com.dxfeed.ipf.InstrumentProfile Class Reference

Represents basic profile information about market instrument. Please see Instrument Profile Format documentation for complete description. More...

Inheritance diagram for com.dxfeed.ipf.InstrumentProfile:
[legend]
Collaboration diagram for com.dxfeed.ipf.InstrumentProfile:
[legend]

Public Member Functions

 InstrumentProfile ()
 Creates an instrument profile with default values. More...
 
 InstrumentProfile (InstrumentProfile ip)
 Creates an instrument profile as a copy of the specified instrument profile. More...
 
string GetTypeName ()
 Returns type of instrument. It takes precedence in conflict cases with other fields. It is a mandatory field. It may not be empty. Example: "STOCK", "FUTURE", "OPTION". More...
 
void SetType (string type)
 Changes type of instrument. It takes precedence in conflict cases with other fields. It is a mandatory field. It may not be empty. Example: "STOCK", "FUTURE", "OPTION". More...
 
string GetSymbol ()
 Returns identifier of instrument, preferable an international one in Latin alphabet. It is a mandatory field. It may not be empty. Example: "GOOG", "/YGM9", ".ZYEAD". More...
 
void SetSymbol (string symbol)
 Changes identifier of instrument, preferable an international one in Latin alphabet. It is a mandatory field. It may not be empty. Example: "GOOG", "/YGM9", ".ZYEAD". More...
 
string GetDescription ()
 Returns description of instrument, preferable an international one in Latin alphabet. Example: "Google Inc.", "Mini Gold Futures,Jun-2009,ETH". More...
 
void SetDescription (string description)
 Changes description of instrument, preferable an international one in Latin alphabet. Example: "Google Inc.", "Mini Gold Futures,Jun-2009,ETH". More...
 
string GetLocalSymbol ()
 Returns identifier of instrument in national language. It shall be empty if same as symbol. More...
 
void SetLocalSymbol (string localSymbol)
 Changes identifier of instrument in national language. It shall be empty if same as symbol. More...
 
string GetLocalDescription ()
 Returns description of instrument in national language. It shall be empty if same as description. More...
 
void SetLocalDescription (string localDescription)
 Changes description of instrument in national language. It shall be empty if same as description. More...
 
string GetCountry ()
 Returns country of origin (incorporation) of corresponding company or parent entity. It shall use two-letter country code from ISO 3166-1 standard. See ISO 3166-1 on Wikipedia. Example: "US", "RU". More...
 
void SetCountry (string country)
 Changes country of origin (incorporation) of corresponding company or parent entity. It shall use two-letter country code from ISO 3166-1 standard. See ISO 3166-1 on Wikipedia. Example: "US", "RU". More...
 
string GetOPOL ()
 Returns official Place Of Listing, the organization that have listed this instrument. Instruments with multiple listings shall use separate profiles for each listing. It shall use Market Identifier Code (MIC) from ISO 10383 standard. See ISO 10383 on Wikipedia or MIC homepage. Example: "XNAS", "RTSX"/ More...
 
void SetOPOL (string opol)
 Changes official Place Of Listing, the organization that have listed this instrument. Instruments with multiple listings shall use separate profiles for each listing. It shall use Market Identifier Code (MIC) from ISO 10383 standard. See ISO 10383 on Wikipedia or MIC homepage. Example: "XNAS", "RTSX"/ More...
 
string GetExchangeData ()
 Returns exchange-specific data required to properly identify instrument when communicating with exchange. It uses exchange-specific format. More...
 
void SetExchangeData (string exchangeData)
 Changes exchange-specific data required to properly identify instrument when communicating with exchange. It uses exchange-specific format. More...
 
string GetExchanges ()
 Returns list of exchanges where instrument is quoted or traded. Its shall use the following format: More...
 
void SetExchanges (string exchanges)
 Changes list of exchanges where instrument is quoted or traded. It shall use the following format: More...
 
string GetCurrency ()
 Returns currency of quotation, pricing and trading. It shall use three-letter currency code from ISO 4217 standard. See ISO 4217 on Wikipedia. Example: "USD", "RUB". More...
 
void SetCurrency (string currency)
 Changes currency of quotation, pricing and trading. It shall use three-letter currency code from ISO 4217 standard. See ISO 4217 on Wikipedia. Example: "USD", "RUB". More...
 
string GetBaseCurrency ()
 Returns base currency of currency pair (FOREX instruments). It shall use three-letter currency code similarly to currency. More...
 
void SetBaseCurrency (string baseCurrency)
 Changes base currency of currency pair (FOREX instruments). It shall use three-letter currency code similarly to currency. More...
 
string GetCFI ()
 Returns Classification of Financial Instruments code. It is a mandatory field for OPTION instruments as it is the only way to distinguish Call/Put type, American/European exercise, Cash/Physical delivery. It shall use six-letter CFI code from ISO 10962 standard. It is allowed to use 'X' extensively and to omit trailing letters (assumed to be 'X'). See ISO 10962 on Wikipedia. Example: "ESNTPB", "ESXXXX", "ES" , "OPASPS". More...
 
void SetCFI (string cfi)
 Changes Classification of Financial Instruments code. It is a mandatory field for OPTION instruments as it is the only way to distinguish Call/Put type, American/European exercise, Cash/Physical delivery. It shall use six-letter CFI code from ISO 10962 standard. It is allowed to use 'X' extensively and to omit trailing letters (assumed to be 'X'). See ISO 10962 on Wikipedia. Example: "ESNTPB", "ESXXXX", "ES" , "OPASPS". More...
 
string GetISIN ()
 Returns International Securities Identifying Number. It shall use twelve-letter code from ISO 6166 standard. See ISO 6166 on Wikipedia or ISIN on Wikipedia. Example: "DE0007100000", "US38259P5089". More...
 
void SetISIN (string isin)
 Changes International Securities Identifying Number. It shall use twelve-letter code from ISO 6166 standard. See ISO 6166 on Wikipedia or ISIN on Wikipedia. Example: "DE0007100000", "US38259P5089". More...
 
string GetSEDOL ()
 Returns Stock Exchange Daily Official List. It shall use seven-letter code assigned by London Stock Exchange. See SEDOL on Wikipedia or SEDOL on LSE. Example: "2310967", "5766857". More...
 
void SetSEDOL (string sedol)
 Changes Stock Exchange Daily Official List. It shall use seven-letter code assigned by London Stock Exchange. See SEDOL on Wikipedia or SEDOL on LSE. Example: "2310967", "5766857". More...
 
string GetCUSIP ()
 Returns Committee on Uniform Security Identification Procedures code. It shall use nine-letter code assigned by CUSIP Services Bureau. See CUSIP on Wikipedia. Example: "38259P508". More...
 
void SetCUSIP (string cusip)
 Changes Committee on Uniform Security Identification Procedures code. It shall use nine-letter code assigned by CUSIP Services Bureau. See CUSIP on Wikipedia. Example: "38259P508". More...
 
int GetICB ()
 Returns Industry Classification Benchmark. It shall use four-digit number from ICB catalog. See ICB on Wikipedia or ICB homepage. Example: "9535". More...
 
void SetICB (int icb)
 Changes Industry Classification Benchmark. It shall use four-digit number from ICB catalog. See ICB on Wikipedia or ICB homepage. Example: "9535". More...
 
int GetSIC ()
 Returns Standard Industrial Classification. It shall use four-digit number from SIC catalog. See SIC on Wikipedia or SIC structure. Example: "7371". More...
 
void SetSIC (int sic)
 Changes Standard Industrial Classification. It shall use four-digit number from SIC catalog. See SIC on Wikipedia or SIC structure. Example: "7371". More...
 
double GetMultiplier ()
 Returns market value multiplier. Example: 100, 33.2. More...
 
void SetMultiplier (double multiplier)
 Changes market value multiplier. Example: 100, 33.2. More...
 
string GetProduct ()
 Returns product for futures and options on futures (underlying asset name). Example: "/YG". More...
 
void SetProduct (string product)
 Changes product for futures and options on futures (underlying asset name). Example: "/YG". More...
 
string GetUnderlying ()
 Returns primary underlying symbol for options. Example: "C", "/YGM9" More...
 
void SetUnderlying (string underlying)
 Changes primary underlying symbol for options. Example: "C", "/YGM9" More...
 
double GetSPC ()
 Returns shares per contract for options. Example: 1, 100. More...
 
void SetSPC (double spc)
 Changes shares per contract for options. Example: 1, 100. More...
 
string GetAdditionalUnderlyings ()
 Returns additional underlyings for options, including additional cash. It shall use following format: More...
 
void SetAdditionalUnderlyings (string additionalUnderlyings)
 Changes additional underlyings for options, including additional cash. It shall use following format: More...
 
string GetMMY ()
 Returns maturity month-year as provided for corresponding FIX tag (200). It can use several different formats depending on data source: More...
 
void SetMMY (string mmy)
 Changes maturity month-year as provided for corresponding FIX tag (200). It can use several different formats depending on data source: More...
 
int GetExpiration ()
 Returns day id of expiration. Example: DayUtil.GetDayIdByYearMonthDay(20090117). More...
 
void SetExpiration (int expiration)
 Changes day id of expiration. Example: DayUtil.GetDayIdByYearMonthDay(20090117). More...
 
int GetLastTrade ()
 Returns day id of last trading day. Example: DayUtil.GetDayIdByYearMonthDay(20090116). More...
 
void SetLastTrade (int lastTrade)
 Changes day id of last trading day. Example: DayUtil.GetDayIdByYearMonthDay(20090116). More...
 
double GetStrike ()
 Returns strike price for options. Example: 80, 22.5. More...
 
void SetStrike (double strike)
 Changes strike price for options. Example: 80, 22.5. More...
 
string GetOptionType ()
 Returns type of option. It shall use one of following values: More...
 
void SetOptionType (string optionType)
 Changes type of option. It shall use one of following values: More...
 
string GetExpirationStyle ()
 Returns expiration cycle style, such as "Weeklys", "Quarterlys". More...
 
void SetExpirationStyle (string expirationStyle)
 Returns expiration cycle style, such as "Weeklys", "Quarterlys". More...
 
string GetSettlementStyle ()
 Returns settlement price determination style, such as "Open", "Close". More...
 
void SetSettlementStyle (string settlementStyle)
 Changes settlement price determination style, such as "Open", "Close". More...
 
string GetPriceIncrements ()
 Returns minimum allowed price increments with corresponding price ranges. It shall use following format: More...
 
void SetPriceIncrements (string priceIncrements)
 Changes minimum allowed price increments with corresponding price ranges. It shall use following format: More...
 
string GetTradingHours ()
 Returns trading hours specification. See Schedule::getInstance(string). More...
 
void SetTradingHours (string tradingHours)
 Changes trading hours specification. See Schedule::getInstance(string). More...
 
string GetField (string name)
 Returns field value with a specified name. More...
 
void SetField (string name, string value)
 Changes field value with a specified name. More...
 
double GetNumericField (string name)
 Returns numeric field value with a specified name. More...
 
void SetNumericField (string name, double value)
 Changes numeric field value with a specified name. More...
 
int GetDateField (string name)
 Returns day id value for a date field with a specified name. More...
 
void SetDateField (string name, int value)
 Changes day id value for a date field with a specified name. More...
 
bool AddNonEmptyCustomFieldNames (ICollection< string > targetFieldNames)
 Adds names of non-empty custom fields to specified collection. More...
 
override bool Equals (object o)
 Indicates whether some other object is "equal to" this one. More...
 
override int GetHashCode ()
 Returns a hash code value for the object. More...
 
bool CustomEquals< TKey, TValue > (Dictionary< TKey, TValue > dict1, Dictionary< TKey, TValue > dict2)
 
int CompareTo (InstrumentProfile ip)
 Compares this profile with the specified profile for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. More...
 
override string ToString ()
 Returns a string representation of the instrument profile. More...
 

Private Member Functions

string GetCustomField (string name)
 Returns custom field value with a specified name. More...
 
void SetCustomField (string name, string value)
 Changes custom field value with a specified name. More...
 

Static Private Member Functions

static int CustomHashCode (Dictionary< string, string > dict)
 

Private Attributes

string type = ""
 
string symbol = ""
 
string description = ""
 
string localSymbol = ""
 
string localDescription = ""
 
string country = ""
 
string opol = ""
 
string exchangeData = ""
 
string exchanges = ""
 
string currency = ""
 
string baseCurrency = ""
 
string cfi = ""
 
string isin = ""
 
string sedol = ""
 
string cusip = ""
 
int icb
 
int sic
 
double multiplier
 
string product = ""
 
string underlying = ""
 
double spc
 
string additionalUnderlyings = ""
 
string mmy = ""
 
int expiration
 
int lastTrade
 
double strike
 
string optionType = ""
 
string expirationStyle = ""
 
string settlementStyle = ""
 
string priceIncrements = ""
 
string tradingHours = ""
 
Dictionary< string, string > customFields = new Dictionary<string, string>()
 

Detailed Description

Represents basic profile information about market instrument. Please see Instrument Profile Format documentation for complete description.

Constructor & Destructor Documentation

◆ InstrumentProfile() [1/2]

com.dxfeed.ipf.InstrumentProfile.InstrumentProfile ( )
inline

Creates an instrument profile with default values.

◆ InstrumentProfile() [2/2]

com.dxfeed.ipf.InstrumentProfile.InstrumentProfile ( InstrumentProfile  ip)
inline

Creates an instrument profile as a copy of the specified instrument profile.

Parameters
ipIp an instrument profile to copy.

Member Function Documentation

◆ AddNonEmptyCustomFieldNames()

bool com.dxfeed.ipf.InstrumentProfile.AddNonEmptyCustomFieldNames ( ICollection< string >  targetFieldNames)
inline

Adds names of non-empty custom fields to specified collection.

Parameters
targetFieldNames
Returns
true if targetFieldNames changed as a result of the call

◆ CompareTo()

int com.dxfeed.ipf.InstrumentProfile.CompareTo ( InstrumentProfile  ip)
inline

Compares this profile with the specified profile for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The natural ordering implied by this method is designed for convenient data representation in a file and shall not be used for business purposes.

Parameters
ip
Returns

◆ CustomEquals< TKey, TValue >()

bool com.dxfeed.ipf.InstrumentProfile.CustomEquals< TKey, TValue > ( Dictionary< TKey, TValue >  dict1,
Dictionary< TKey, TValue >  dict2 
)
inline

◆ CustomHashCode()

static int com.dxfeed.ipf.InstrumentProfile.CustomHashCode ( Dictionary< string, string >  dict)
inlinestaticprivate

◆ Equals()

override bool com.dxfeed.ipf.InstrumentProfile.Equals ( object  o)
inline

Indicates whether some other object is "equal to" this one.

Parameters
oThe reference object with which to compare.
Returns
true if this object is the same as the obj argument; false otherwise.

◆ GetAdditionalUnderlyings()

string com.dxfeed.ipf.InstrumentProfile.GetAdditionalUnderlyings ( )
inline

Returns additional underlyings for options, including additional cash. It shall use following format:

    <VALUE> ::= <empty> | <LIST>
    <LIST> ::= <AU> | <AU> <semicolon> <space> <LIST>
    <AU> ::= <UNDERLYING> <space> <SPC> 

the list shall be sorted by <UNDERLYING>. Example: "SE 50", "FIS 53; US$ 45.46".

Returns
Additional underlyings for options, including additional cash.

◆ GetBaseCurrency()

string com.dxfeed.ipf.InstrumentProfile.GetBaseCurrency ( )
inline

Returns base currency of currency pair (FOREX instruments). It shall use three-letter currency code similarly to currency.

Returns
Base currency of currency pair (FOREX instruments).

◆ GetCFI()

string com.dxfeed.ipf.InstrumentProfile.GetCFI ( )
inline

Returns Classification of Financial Instruments code. It is a mandatory field for OPTION instruments as it is the only way to distinguish Call/Put type, American/European exercise, Cash/Physical delivery. It shall use six-letter CFI code from ISO 10962 standard. It is allowed to use 'X' extensively and to omit trailing letters (assumed to be 'X'). See ISO 10962 on Wikipedia. Example: "ESNTPB", "ESXXXX", "ES" , "OPASPS".

Returns
CFI code.

◆ GetCountry()

string com.dxfeed.ipf.InstrumentProfile.GetCountry ( )
inline

Returns country of origin (incorporation) of corresponding company or parent entity. It shall use two-letter country code from ISO 3166-1 standard. See ISO 3166-1 on Wikipedia. Example: "US", "RU".

Returns
Country of origin (incorporation) of corresponding company or parent entity.

◆ GetCurrency()

string com.dxfeed.ipf.InstrumentProfile.GetCurrency ( )
inline

Returns currency of quotation, pricing and trading. It shall use three-letter currency code from ISO 4217 standard. See ISO 4217 on Wikipedia. Example: "USD", "RUB".

Returns
Currency of quotation, pricing and trading.

◆ GetCUSIP()

string com.dxfeed.ipf.InstrumentProfile.GetCUSIP ( )
inline

Returns Committee on Uniform Security Identification Procedures code. It shall use nine-letter code assigned by CUSIP Services Bureau. See CUSIP on Wikipedia. Example: "38259P508".

Returns
CUSIP code.

◆ GetCustomField()

string com.dxfeed.ipf.InstrumentProfile.GetCustomField ( string  name)
inlineprivate

Returns custom field value with a specified name.

Parameters
nameName of custom field.
Returns
Custom field value with a specified name.

◆ GetDateField()

int com.dxfeed.ipf.InstrumentProfile.GetDateField ( string  name)
inline

Returns day id value for a date field with a specified name.

Parameters
nameName of field.
Returns
Day id value.
Exceptions
System.ArgumentExceptionIf this field has no numeric (date) representation.
System.InvalidOperationExceptionIf number formatter error occurs.

◆ GetDescription()

string com.dxfeed.ipf.InstrumentProfile.GetDescription ( )
inline

Returns description of instrument, preferable an international one in Latin alphabet. Example: "Google Inc.", "Mini Gold Futures,Jun-2009,ETH".

Returns
Description of instrument.

◆ GetExchangeData()

string com.dxfeed.ipf.InstrumentProfile.GetExchangeData ( )
inline

Returns exchange-specific data required to properly identify instrument when communicating with exchange. It uses exchange-specific format.

Returns
Exchange-specific data required to properly identify instrument when communicating with exchange.

◆ GetExchanges()

string com.dxfeed.ipf.InstrumentProfile.GetExchanges ( )
inline

Returns list of exchanges where instrument is quoted or traded. Its shall use the following format:

    <VALUE> ::= <empty> | <LIST>
    <IST> ::= <MIC> | <MIC> <semicolon> 

<LIST> the list shall be sorted by MIC. Example: "ARCX;CBSX ;XNAS;XNYS".

Returns
List of exchanges where instrument is quoted or traded.

◆ GetExpiration()

int com.dxfeed.ipf.InstrumentProfile.GetExpiration ( )
inline

Returns day id of expiration. Example: DayUtil.GetDayIdByYearMonthDay(20090117).

Returns
Day id of expiration.

◆ GetExpirationStyle()

string com.dxfeed.ipf.InstrumentProfile.GetExpirationStyle ( )
inline

Returns expiration cycle style, such as "Weeklys", "Quarterlys".

Returns
Expiration cycle style.

◆ GetField()

string com.dxfeed.ipf.InstrumentProfile.GetField ( string  name)
inline

Returns field value with a specified name.

Parameters
nameName of field.
Returns
Field value.
Exceptions
System.ArgumentNullExceptionIf name is null.
System.InvalidOperationExceptionCan't format certain field.

◆ GetHashCode()

override int com.dxfeed.ipf.InstrumentProfile.GetHashCode ( )
inline

Returns a hash code value for the object.

Returns
A hash code value for this object.

◆ GetICB()

int com.dxfeed.ipf.InstrumentProfile.GetICB ( )
inline

Returns Industry Classification Benchmark. It shall use four-digit number from ICB catalog. See ICB on Wikipedia or ICB homepage. Example: "9535".

Returns
Industry Classification Benchmark.

◆ GetISIN()

string com.dxfeed.ipf.InstrumentProfile.GetISIN ( )
inline

Returns International Securities Identifying Number. It shall use twelve-letter code from ISO 6166 standard. See ISO 6166 on Wikipedia or ISIN on Wikipedia. Example: "DE0007100000", "US38259P5089".

Returns
International Securities Identifying Number.
Returns

◆ GetLastTrade()

int com.dxfeed.ipf.InstrumentProfile.GetLastTrade ( )
inline

Returns day id of last trading day. Example: DayUtil.GetDayIdByYearMonthDay(20090116).

Returns
Day id of last trading day.

◆ GetLocalDescription()

string com.dxfeed.ipf.InstrumentProfile.GetLocalDescription ( )
inline

Returns description of instrument in national language. It shall be empty if same as description.

Returns
Description of instrument in national language.

◆ GetLocalSymbol()

string com.dxfeed.ipf.InstrumentProfile.GetLocalSymbol ( )
inline

Returns identifier of instrument in national language. It shall be empty if same as symbol.

Returns
Identifier of instrument in national language.

◆ GetMMY()

string com.dxfeed.ipf.InstrumentProfile.GetMMY ( )
inline

Returns maturity month-year as provided for corresponding FIX tag (200). It can use several different formats depending on data source:

  • YYYYMM – if only year and month are specified
  • YYYYMMDD – if full date is specified
  • YYYYMMwN – if week number (within a month) is specified
Returns
Maturity month-year as provided for corresponding FIX tag (200).

◆ GetMultiplier()

double com.dxfeed.ipf.InstrumentProfile.GetMultiplier ( )
inline

Returns market value multiplier. Example: 100, 33.2.

Returns
Market value multiplier.

◆ GetNumericField()

double com.dxfeed.ipf.InstrumentProfile.GetNumericField ( string  name)
inline

Returns numeric field value with a specified name.

Parameters
nameName of field.
Returns
Field value.
Exceptions
System.ArgumentExceptionIf this field has no numeric representation.
System.InvalidOperationExceptionIf number formatter error occurs.

◆ GetOPOL()

string com.dxfeed.ipf.InstrumentProfile.GetOPOL ( )
inline

Returns official Place Of Listing, the organization that have listed this instrument. Instruments with multiple listings shall use separate profiles for each listing. It shall use Market Identifier Code (MIC) from ISO 10383 standard. See ISO 10383 on Wikipedia or MIC homepage. Example: "XNAS", "RTSX"/

Returns
Official Place Of Listing, the organization that have listed this instrument.

◆ GetOptionType()

string com.dxfeed.ipf.InstrumentProfile.GetOptionType ( )
inline

Returns type of option. It shall use one of following values:

  • STAN = Standard Options
  • LEAP = Long-term Equity AnticiPation Securities
  • SDO = Special Dated Options
  • BINY = Binary Options
  • FLEX = FLexible EXchange Options
  • VSO = Variable Start Options
  • RNGE = Range
Returns
Type of option.

◆ GetPriceIncrements()

string com.dxfeed.ipf.InstrumentProfile.GetPriceIncrements ( )
inline

Returns minimum allowed price increments with corresponding price ranges. It shall use following format:

    <VALUE> ::= <empty> | <LIST>
    <LIST> ::= <INCREMENT> | <RANGE> <semicolon> <space> <LIST>
    <RANGE> ::= <INCREMENT> <space> <UPPER_LIMIT>

the list shall be sorted by <UPPER_LIMIT>. Example: "0.25", "0.01 3; 0.05".

Returns
Minimum allowed price increments with corresponding price ranges.

◆ GetProduct()

string com.dxfeed.ipf.InstrumentProfile.GetProduct ( )
inline

Returns product for futures and options on futures (underlying asset name). Example: "/YG".

Returns
Product for futures and options on futures (underlying asset name).

◆ GetSEDOL()

string com.dxfeed.ipf.InstrumentProfile.GetSEDOL ( )
inline

Returns Stock Exchange Daily Official List. It shall use seven-letter code assigned by London Stock Exchange. See SEDOL on Wikipedia or SEDOL on LSE. Example: "2310967", "5766857".

Returns
Exchange Daily Official List.

◆ GetSettlementStyle()

string com.dxfeed.ipf.InstrumentProfile.GetSettlementStyle ( )
inline

Returns settlement price determination style, such as "Open", "Close".

Returns
Settlement price determination style.

◆ GetSIC()

int com.dxfeed.ipf.InstrumentProfile.GetSIC ( )
inline

Returns Standard Industrial Classification. It shall use four-digit number from SIC catalog. See SIC on Wikipedia or SIC structure. Example: "7371".

Returns
Standard Industrial Classification.

◆ GetSPC()

double com.dxfeed.ipf.InstrumentProfile.GetSPC ( )
inline

Returns shares per contract for options. Example: 1, 100.

Returns
Shares per contract for options.

◆ GetStrike()

double com.dxfeed.ipf.InstrumentProfile.GetStrike ( )
inline

Returns strike price for options. Example: 80, 22.5.

Returns
Strike price for options.

◆ GetSymbol()

string com.dxfeed.ipf.InstrumentProfile.GetSymbol ( )
inline

Returns identifier of instrument, preferable an international one in Latin alphabet. It is a mandatory field. It may not be empty. Example: "GOOG", "/YGM9", ".ZYEAD".

Returns
Identifier of instrument.

◆ GetTradingHours()

string com.dxfeed.ipf.InstrumentProfile.GetTradingHours ( )
inline

Returns trading hours specification. See Schedule::getInstance(string).

Returns
Trading hours specification.

◆ GetTypeName()

string com.dxfeed.ipf.InstrumentProfile.GetTypeName ( )
inline

Returns type of instrument. It takes precedence in conflict cases with other fields. It is a mandatory field. It may not be empty. Example: "STOCK", "FUTURE", "OPTION".

Returns
Type of instrument.

◆ GetUnderlying()

string com.dxfeed.ipf.InstrumentProfile.GetUnderlying ( )
inline

Returns primary underlying symbol for options. Example: "C", "/YGM9"

Returns
Primary underlying symbol for options.

◆ SetAdditionalUnderlyings()

void com.dxfeed.ipf.InstrumentProfile.SetAdditionalUnderlyings ( string  additionalUnderlyings)
inline

Changes additional underlyings for options, including additional cash. It shall use following format:

    <VALUE> ::= <empty> | <LIST>
    <LIST> ::= <AU> | <AU> <semicolon> <space> <LIST>
    <AU> ::= <UNDERLYING> <space> <SPC> 

the list shall be sorted by <UNDERLYING>. Example: "SE 50", "FIS 53; US$ 45.46".

Parameters
additionalUnderlyingsAdditionalUnderlyings additional underlyings for options, including additional cash.

◆ SetBaseCurrency()

void com.dxfeed.ipf.InstrumentProfile.SetBaseCurrency ( string  baseCurrency)
inline

Changes base currency of currency pair (FOREX instruments). It shall use three-letter currency code similarly to currency.

Parameters
baseCurrencyBaseCurrency base currency of currency pair (FOREX instruments).

◆ SetCFI()

void com.dxfeed.ipf.InstrumentProfile.SetCFI ( string  cfi)
inline

Changes Classification of Financial Instruments code. It is a mandatory field for OPTION instruments as it is the only way to distinguish Call/Put type, American/European exercise, Cash/Physical delivery. It shall use six-letter CFI code from ISO 10962 standard. It is allowed to use 'X' extensively and to omit trailing letters (assumed to be 'X'). See ISO 10962 on Wikipedia. Example: "ESNTPB", "ESXXXX", "ES" , "OPASPS".

Parameters
cfiCFI code.

◆ SetCountry()

void com.dxfeed.ipf.InstrumentProfile.SetCountry ( string  country)
inline

Changes country of origin (incorporation) of corresponding company or parent entity. It shall use two-letter country code from ISO 3166-1 standard. See ISO 3166-1 on Wikipedia. Example: "US", "RU".

Parameters
countryCountry of origin (incorporation) of corresponding company or parent entity.

◆ SetCurrency()

void com.dxfeed.ipf.InstrumentProfile.SetCurrency ( string  currency)
inline

Changes currency of quotation, pricing and trading. It shall use three-letter currency code from ISO 4217 standard. See ISO 4217 on Wikipedia. Example: "USD", "RUB".

Parameters
currencyCurrency currency of quotation, pricing and trading.

◆ SetCUSIP()

void com.dxfeed.ipf.InstrumentProfile.SetCUSIP ( string  cusip)
inline

Changes Committee on Uniform Security Identification Procedures code. It shall use nine-letter code assigned by CUSIP Services Bureau. See CUSIP on Wikipedia. Example: "38259P508".

Parameters
cusipCUSIP code.

◆ SetCustomField()

void com.dxfeed.ipf.InstrumentProfile.SetCustomField ( string  name,
string  value 
)
inlineprivate

Changes custom field value with a specified name.

Parameters
nameName of custom field.
valueCustom field value.

◆ SetDateField()

void com.dxfeed.ipf.InstrumentProfile.SetDateField ( string  name,
int  value 
)
inline

Changes day id value for a date field with a specified name.

Parameters
nameName of field.
valueDay id value.
Exceptions
System.ArgumentExceptionIf this field has no numeric (date) representation.
System.InvalidOperationExceptionIf number formatter error occurs.

◆ SetDescription()

void com.dxfeed.ipf.InstrumentProfile.SetDescription ( string  description)
inline

Changes description of instrument, preferable an international one in Latin alphabet. Example: "Google Inc.", "Mini Gold Futures,Jun-2009,ETH".

Parameters
descriptionDescription of instrument.

◆ SetExchangeData()

void com.dxfeed.ipf.InstrumentProfile.SetExchangeData ( string  exchangeData)
inline

Changes exchange-specific data required to properly identify instrument when communicating with exchange. It uses exchange-specific format.

Parameters
exchangeDataExchange-specific data required to properly identify instrument when communicating with exchange.

◆ SetExchanges()

void com.dxfeed.ipf.InstrumentProfile.SetExchanges ( string  exchanges)
inline

Changes list of exchanges where instrument is quoted or traded. It shall use the following format:

    <VALUE> ::= <empty> | <LIST>
    <IST> ::= <MIC> | <MIC> <semicolon> 

<LIST> the list shall be sorted by MIC. Example: "ARCX;CBSX ;XNAS;XNYS".

Parameters
exchangesList of exchanges where instrument is quoted or traded.

◆ SetExpiration()

void com.dxfeed.ipf.InstrumentProfile.SetExpiration ( int  expiration)
inline

Changes day id of expiration. Example: DayUtil.GetDayIdByYearMonthDay(20090117).

Parameters
expirationExpiration day id of expiration.

◆ SetExpirationStyle()

void com.dxfeed.ipf.InstrumentProfile.SetExpirationStyle ( string  expirationStyle)
inline

Returns expiration cycle style, such as "Weeklys", "Quarterlys".

Parameters
expirationStyleExpiration cycle style.

◆ SetField()

void com.dxfeed.ipf.InstrumentProfile.SetField ( string  name,
string  value 
)
inline

Changes field value with a specified name.

Parameters
nameName of field.
valueField value.
Exceptions
System.ArgumentNullExceptionIf name is null.
System.InvalidOperationExceptionIf text uses wrong format or contains invalid values.

◆ SetICB()

void com.dxfeed.ipf.InstrumentProfile.SetICB ( int  icb)
inline

Changes Industry Classification Benchmark. It shall use four-digit number from ICB catalog. See ICB on Wikipedia or ICB homepage. Example: "9535".

Parameters
icbIndustry Classification Benchmark.

◆ SetISIN()

void com.dxfeed.ipf.InstrumentProfile.SetISIN ( string  isin)
inline

Changes International Securities Identifying Number. It shall use twelve-letter code from ISO 6166 standard. See ISO 6166 on Wikipedia or ISIN on Wikipedia. Example: "DE0007100000", "US38259P5089".

Parameters
isinInternational Securities Identifying Number.

◆ SetLastTrade()

void com.dxfeed.ipf.InstrumentProfile.SetLastTrade ( int  lastTrade)
inline

Changes day id of last trading day. Example: DayUtil.GetDayIdByYearMonthDay(20090116).

Parameters
lastTradeDay id of last trading day.

◆ SetLocalDescription()

void com.dxfeed.ipf.InstrumentProfile.SetLocalDescription ( string  localDescription)
inline

Changes description of instrument in national language. It shall be empty if same as description.

Parameters
localDescriptionDescription of instrument in national language.

◆ SetLocalSymbol()

void com.dxfeed.ipf.InstrumentProfile.SetLocalSymbol ( string  localSymbol)
inline

Changes identifier of instrument in national language. It shall be empty if same as symbol.

Parameters
localSymbolIdentifier of instrument in national language.

◆ SetMMY()

void com.dxfeed.ipf.InstrumentProfile.SetMMY ( string  mmy)
inline

Changes maturity month-year as provided for corresponding FIX tag (200). It can use several different formats depending on data source:

  • YYYYMM – if only year and month are specified
  • YYYYMMDD – if full date is specified
  • YYYYMMwN – if week number (within a month) is specified
Parameters
mmyMaturity month-year as provided for corresponding FIX tag (200).

◆ SetMultiplier()

void com.dxfeed.ipf.InstrumentProfile.SetMultiplier ( double  multiplier)
inline

Changes market value multiplier. Example: 100, 33.2.

Parameters
multiplierMultiplier market value multiplier.

◆ SetNumericField()

void com.dxfeed.ipf.InstrumentProfile.SetNumericField ( string  name,
double  value 
)
inline

Changes numeric field value with a specified name.

Parameters
nameName of field.
valueField value.
Exceptions
System.ArgumentExceptionIf this field has no numeric representation.
System.InvalidOperationExceptionIf number formatter error occurs.

◆ SetOPOL()

void com.dxfeed.ipf.InstrumentProfile.SetOPOL ( string  opol)
inline

Changes official Place Of Listing, the organization that have listed this instrument. Instruments with multiple listings shall use separate profiles for each listing. It shall use Market Identifier Code (MIC) from ISO 10383 standard. See ISO 10383 on Wikipedia or MIC homepage. Example: "XNAS", "RTSX"/

Parameters
opolOfficial Place Of Listing, the organization that have listed this instrument.

◆ SetOptionType()

void com.dxfeed.ipf.InstrumentProfile.SetOptionType ( string  optionType)
inline

Changes type of option. It shall use one of following values:

  • STAN = Standard Options
  • LEAP = Long-term Equity AnticiPation Securities
  • SDO = Special Dated Options
  • BINY = Binary Options
  • FLEX = FLexible EXchange Options
  • VSO = Variable Start Options
  • RNGE = Range
Parameters
optionTypeType of option.

◆ SetPriceIncrements()

void com.dxfeed.ipf.InstrumentProfile.SetPriceIncrements ( string  priceIncrements)
inline

Changes minimum allowed price increments with corresponding price ranges. It shall use following format:

    <VALUE> ::= <empty> | <LIST>
    <LIST> ::= <INCREMENT> | <RANGE> <semicolon> <space> <LIST>
    <RANGE> ::= <INCREMENT> <space> <UPPER_LIMIT>

the list shall be sorted by <UPPER_LIMIT>. Example: "0.25", "0.01 3; 0.05".

Parameters
priceIncrementsMinimum allowed price increments with corresponding price ranges.

◆ SetProduct()

void com.dxfeed.ipf.InstrumentProfile.SetProduct ( string  product)
inline

Changes product for futures and options on futures (underlying asset name). Example: "/YG".

Parameters
productProduct product for futures and options on futures (underlying asset name).

◆ SetSEDOL()

void com.dxfeed.ipf.InstrumentProfile.SetSEDOL ( string  sedol)
inline

Changes Stock Exchange Daily Official List. It shall use seven-letter code assigned by London Stock Exchange. See SEDOL on Wikipedia or SEDOL on LSE. Example: "2310967", "5766857".

Parameters
sedolStock Exchange Daily Official List.

◆ SetSettlementStyle()

void com.dxfeed.ipf.InstrumentProfile.SetSettlementStyle ( string  settlementStyle)
inline

Changes settlement price determination style, such as "Open", "Close".

Parameters
settlementStyleSettlement price determination style.

◆ SetSIC()

void com.dxfeed.ipf.InstrumentProfile.SetSIC ( int  sic)
inline

Changes Standard Industrial Classification. It shall use four-digit number from SIC catalog. See SIC on Wikipedia or SIC structure. Example: "7371".

Parameters
sicStandard Industrial Classification.

◆ SetSPC()

void com.dxfeed.ipf.InstrumentProfile.SetSPC ( double  spc)
inline

Changes shares per contract for options. Example: 1, 100.

Parameters
spcShares per contract for options.

◆ SetStrike()

void com.dxfeed.ipf.InstrumentProfile.SetStrike ( double  strike)
inline

Changes strike price for options. Example: 80, 22.5.

Parameters
strikeStrike strike price for options.

◆ SetSymbol()

void com.dxfeed.ipf.InstrumentProfile.SetSymbol ( string  symbol)
inline

Changes identifier of instrument, preferable an international one in Latin alphabet. It is a mandatory field. It may not be empty. Example: "GOOG", "/YGM9", ".ZYEAD".

Parameters
symbolSymbol identifier of instrument.

◆ SetTradingHours()

void com.dxfeed.ipf.InstrumentProfile.SetTradingHours ( string  tradingHours)
inline

Changes trading hours specification. See Schedule::getInstance(string).

Parameters
tradingHoursTrading hours specification.

◆ SetType()

void com.dxfeed.ipf.InstrumentProfile.SetType ( string  type)
inline

Changes type of instrument. It takes precedence in conflict cases with other fields. It is a mandatory field. It may not be empty. Example: "STOCK", "FUTURE", "OPTION".

Parameters
typeType type of instrument.

◆ SetUnderlying()

void com.dxfeed.ipf.InstrumentProfile.SetUnderlying ( string  underlying)
inline

Changes primary underlying symbol for options. Example: "C", "/YGM9"

Parameters
underlyingUnderlying primary underlying symbol for options.

◆ ToString()

override string com.dxfeed.ipf.InstrumentProfile.ToString ( )
inline

Returns a string representation of the instrument profile.

Returns
String representation of the instrument profile.

Field Documentation

◆ additionalUnderlyings

string com.dxfeed.ipf.InstrumentProfile.additionalUnderlyings = ""
private

◆ baseCurrency

string com.dxfeed.ipf.InstrumentProfile.baseCurrency = ""
private

◆ cfi

string com.dxfeed.ipf.InstrumentProfile.cfi = ""
private

◆ country

string com.dxfeed.ipf.InstrumentProfile.country = ""
private

◆ currency

string com.dxfeed.ipf.InstrumentProfile.currency = ""
private

◆ cusip

string com.dxfeed.ipf.InstrumentProfile.cusip = ""
private

◆ customFields

Dictionary<string, string> com.dxfeed.ipf.InstrumentProfile.customFields = new Dictionary<string, string>()
private

◆ description

string com.dxfeed.ipf.InstrumentProfile.description = ""
private

◆ exchangeData

string com.dxfeed.ipf.InstrumentProfile.exchangeData = ""
private

◆ exchanges

string com.dxfeed.ipf.InstrumentProfile.exchanges = ""
private

◆ expiration

int com.dxfeed.ipf.InstrumentProfile.expiration
private

◆ expirationStyle

string com.dxfeed.ipf.InstrumentProfile.expirationStyle = ""
private

◆ icb

int com.dxfeed.ipf.InstrumentProfile.icb
private

◆ isin

string com.dxfeed.ipf.InstrumentProfile.isin = ""
private

◆ lastTrade

int com.dxfeed.ipf.InstrumentProfile.lastTrade
private

◆ localDescription

string com.dxfeed.ipf.InstrumentProfile.localDescription = ""
private

◆ localSymbol

string com.dxfeed.ipf.InstrumentProfile.localSymbol = ""
private

◆ mmy

string com.dxfeed.ipf.InstrumentProfile.mmy = ""
private

◆ multiplier

double com.dxfeed.ipf.InstrumentProfile.multiplier
private

◆ opol

string com.dxfeed.ipf.InstrumentProfile.opol = ""
private

◆ optionType

string com.dxfeed.ipf.InstrumentProfile.optionType = ""
private

◆ priceIncrements

string com.dxfeed.ipf.InstrumentProfile.priceIncrements = ""
private

◆ product

string com.dxfeed.ipf.InstrumentProfile.product = ""
private

◆ sedol

string com.dxfeed.ipf.InstrumentProfile.sedol = ""
private

◆ settlementStyle

string com.dxfeed.ipf.InstrumentProfile.settlementStyle = ""
private

◆ sic

int com.dxfeed.ipf.InstrumentProfile.sic
private

◆ spc

double com.dxfeed.ipf.InstrumentProfile.spc
private

◆ strike

double com.dxfeed.ipf.InstrumentProfile.strike
private

◆ symbol

string com.dxfeed.ipf.InstrumentProfile.symbol = ""
private

◆ tradingHours

string com.dxfeed.ipf.InstrumentProfile.tradingHours = ""
private

◆ type

string com.dxfeed.ipf.InstrumentProfile.type = ""
private

◆ underlying

string com.dxfeed.ipf.InstrumentProfile.underlying = ""
private

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