dxFeed Graal Native SDK 3.10.0
Loading...
Searching...
No Matches
dxfg_instrument_profile2_t Struct Reference

The fields of an instrument profile in a plain C structure, with the handle of its custom fields. More...

#include <dxfg_ipf.h>

Data Fields

char * type
char * symbol
char * description
char * local_symbol
char * local_description
char * country
char * opol
char * exchange_data
char * exchanges
char * currency
char * base_currency
char * cfi
char * isin
char * sedol
char * cusip
int32_t icb
int32_t sic
double multiplier
char * product
char * underlying
double spc
char * additional_underlyings
char * mmy
int32_t expiration
int32_t last_trade
double strike
char * option_type
char * expiration_style
char * settlement_style
char * price_increments
char * trading_hours
dxfg_instrument_profile_custom_fields_t * instrument_profile_custom_fields
int32_t instrument_profile_custom_fields_hash

Detailed Description

The fields of an instrument profile in a plain C structure, with the handle of its custom fields.

The strings are UTF-8 null-terminated strings that belong to the structure (an empty string if the field is not set). A structure that the SDK fills is released with dxfg_instrument_profile_free() (a single profile, see dxfg_Iterable_InstrumentProfile_next2()), dxfg_instrument_profiles_array_free() (an array) or dxfg_instrument_profile2_list_free() (a list): that frees the strings and releases the custom fields handle.

A structure that is passed to the SDK, e.g. to dxfg_InstrumentProfileCollector_updateInstrumentProfile2(), is only read: the SDK copies the strings, does not keep or free the pointers, treats a NULL string as an empty one and ignores instrument_profile_custom_fields_hash.

The custom fields are not copied: the Java instrument profile and the custom fields handle of the structure share the same storage of the fields, both in a structure that the SDK fills and in a structure passed to the SDK. A change made with dxfg_InstrumentProfileCustomFields_setField() and the like through that handle may change the profile (e.g. the profile in a collector). To change the custom fields independently, make a copy with dxfg_InstrumentProfileCustomFields_new3() first.

Every field is described with the corresponding dxfg_InstrumentProfile_get*() function.

Field Documentation

◆ additional_underlyings

char* dxfg_instrument_profile2_t::additional_underlyings

The additional underlyings for options, see dxfg_InstrumentProfile_getAdditionalUnderlyings().

◆ base_currency

char* dxfg_instrument_profile2_t::base_currency

The base currency of a currency pair, see dxfg_InstrumentProfile_getBaseCurrency().

◆ cfi

char* dxfg_instrument_profile2_t::cfi

The Classification of Financial Instruments code, see dxfg_InstrumentProfile_getCFI().

◆ country

char* dxfg_instrument_profile2_t::country

The country of origin (ISO 3166-1 code), see dxfg_InstrumentProfile_getCountry().

◆ currency

char* dxfg_instrument_profile2_t::currency

The currency of quotation, pricing and trading (ISO 4217 code), see dxfg_InstrumentProfile_getCurrency().

◆ cusip

char* dxfg_instrument_profile2_t::cusip

The CUSIP code, see dxfg_InstrumentProfile_getCUSIP().

◆ description

char* dxfg_instrument_profile2_t::description

The description of the instrument, see dxfg_InstrumentProfile_getDescription().

◆ exchange_data

char* dxfg_instrument_profile2_t::exchange_data

The exchange-specific data, see dxfg_InstrumentProfile_getExchangeData().

◆ exchanges

char* dxfg_instrument_profile2_t::exchanges

The list of the exchanges where the instrument is traded, see dxfg_InstrumentProfile_getExchanges().

◆ expiration

int32_t dxfg_instrument_profile2_t::expiration

The day id of the expiration (days since January 1, 1970, 00:00:00 GMT; 0 if not set).

◆ expiration_style

char* dxfg_instrument_profile2_t::expiration_style

The expiration cycle style, see dxfg_InstrumentProfile_getExpirationStyle().

◆ icb

int32_t dxfg_instrument_profile2_t::icb

The Industry Classification Benchmark number, see dxfg_InstrumentProfile_getICB().

◆ instrument_profile_custom_fields

dxfg_instrument_profile_custom_fields_t* dxfg_instrument_profile2_t::instrument_profile_custom_fields

The handle of the custom fields (the fields that are not standard fields), or NULL if there are none. It belongs to the structure and is released with it: clone it with dxfg_JavaObjectHandler_clone() to keep it. If the structure is passed to the SDK, the custom fields of the handle are assigned to the profile.

◆ instrument_profile_custom_fields_hash

int32_t dxfg_instrument_profile2_t::instrument_profile_custom_fields_hash

The hash code of the custom fields, 0 if they are empty (the handle is then NULL). Equal custom fields give equal hash codes.

◆ isin

char* dxfg_instrument_profile2_t::isin

The International Securities Identifying Number, see dxfg_InstrumentProfile_getISIN().

◆ last_trade

int32_t dxfg_instrument_profile2_t::last_trade

The day id of the last trading day (days since January 1, 1970, 00:00:00 GMT; 0 if not set).

◆ local_description

char* dxfg_instrument_profile2_t::local_description

The description in the national language, see dxfg_InstrumentProfile_getLocalDescription().

◆ local_symbol

char* dxfg_instrument_profile2_t::local_symbol

The identifier of the instrument in the national language, see dxfg_InstrumentProfile_getLocalSymbol().

◆ mmy

char* dxfg_instrument_profile2_t::mmy

The maturity month-year, see dxfg_InstrumentProfile_getMMY().

◆ multiplier

double dxfg_instrument_profile2_t::multiplier

The market value multiplier, see dxfg_InstrumentProfile_getMultiplier().

◆ opol

char* dxfg_instrument_profile2_t::opol

The official Place Of Listing (MIC), see dxfg_InstrumentProfile_getOPOL().

◆ option_type

char* dxfg_instrument_profile2_t::option_type

The type of the option, see dxfg_InstrumentProfile_getOptionType().

◆ price_increments

char* dxfg_instrument_profile2_t::price_increments

The minimum allowed price increments, see dxfg_InstrumentProfile_getPriceIncrements().

◆ product

char* dxfg_instrument_profile2_t::product

The product for futures and options on futures, see dxfg_InstrumentProfile_getProduct().

◆ sedol

char* dxfg_instrument_profile2_t::sedol

The Stock Exchange Daily Official List code, see dxfg_InstrumentProfile_getSEDOL().

◆ settlement_style

char* dxfg_instrument_profile2_t::settlement_style

The settlement price determination style, see dxfg_InstrumentProfile_getSettlementStyle().

◆ sic

int32_t dxfg_instrument_profile2_t::sic

The Standard Industrial Classification number, see dxfg_InstrumentProfile_getSIC().

◆ spc

double dxfg_instrument_profile2_t::spc

The shares per contract for options, see dxfg_InstrumentProfile_getSPC().

◆ strike

double dxfg_instrument_profile2_t::strike

The strike price for options, see dxfg_InstrumentProfile_getStrike().

◆ symbol

char* dxfg_instrument_profile2_t::symbol

The identifier of the instrument, see dxfg_InstrumentProfile_getSymbol().

◆ trading_hours

char* dxfg_instrument_profile2_t::trading_hours

The trading hours specification, see dxfg_InstrumentProfile_getTradingHours().

◆ type

char* dxfg_instrument_profile2_t::type

The type of the instrument, see dxfg_InstrumentProfile_getType().

◆ underlying

char* dxfg_instrument_profile2_t::underlying

The primary underlying symbol for options, see dxfg_InstrumentProfile_getUnderlying().


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