dxFeed Graal Native SDK 3.14.0-rc2
Loading...
Searching...
No Matches
Glossary (v4)

The v4 functions and type names of the group Glossary. Every function returns DXFG_EXECUTE_SUCCESSFULLY or DXFG_EXECUTE_FAIL and writes its result to a DXFG_OUT parameter, see The v4 functions. More...

Data Structures

struct  dxfg_v4_double_list
 A list of doubles: the array holds the values themselves, not pointers to them. More...
struct  dxfg_v4_string_to_double_map_entry_list
 A list of string to double map entries: the array holds the entries themselves, not pointers to them. More...
struct  dxfg_v4_cfi_value_list
 A list of CFI value handles. More...

Typedefs

typedef dxfg_additional_underlyings_t dxfg_v4_additional_underlyings_t
typedef dxfg_cfi_t dxfg_v4_cfi_t
typedef dxfg_cfi_attribute_t dxfg_v4_cfi_attribute_t
typedef dxfg_cfi_value_t dxfg_v4_cfi_value_t
typedef dxfg_price_increments_t dxfg_v4_price_increments_t
typedef struct dxfg_v4_double_list dxfg_v4_double_list
 A list of doubles: the array holds the values themselves, not pointers to them.
typedef struct dxfg_v4_string_to_double_map_entry_list dxfg_v4_string_to_double_map_entry_list
 A list of string to double map entries: the array holds the entries themselves, not pointers to them.
typedef struct dxfg_v4_cfi_value_list dxfg_v4_cfi_value_list
 A list of CFI value handles.

Functions

int32_t dxfg_v4_AdditionalUnderlyings_EMPTY (graal_isolatethread_t *thread, DXFG_OUT dxfg_v4_additional_underlyings_t **emptyAdditionalUnderlyings)
int32_t dxfg_v4_AdditionalUnderlyings_valueOf (graal_isolatethread_t *thread, const char *text, DXFG_OUT dxfg_v4_additional_underlyings_t **additionalUnderlyings)
int32_t dxfg_v4_AdditionalUnderlyings_valueOfMap (graal_isolatethread_t *thread, const dxfg_v4_string_to_double_map_entry_list *map, DXFG_OUT dxfg_v4_additional_underlyings_t **additionalUnderlyings)
int32_t dxfg_v4_AdditionalUnderlyings_getSPCFromText (graal_isolatethread_t *thread, const char *text, const char *symbol, DXFG_OUT double *spc)
int32_t dxfg_v4_AdditionalUnderlyings_getText (graal_isolatethread_t *thread, dxfg_v4_additional_underlyings_t *additionalUnderlyings, DXFG_OUT char **text)
int32_t dxfg_v4_AdditionalUnderlyings_getMap (graal_isolatethread_t *thread, dxfg_v4_additional_underlyings_t *additionalUnderlyings, DXFG_OUT dxfg_v4_string_to_double_map_entry_list **map)
int32_t dxfg_v4_AdditionalUnderlyings_getSPC (graal_isolatethread_t *thread, dxfg_v4_additional_underlyings_t *additionalUnderlyings, const char *symbol, DXFG_OUT double *spc)
int32_t dxfg_v4_CFI_EMPTY (graal_isolatethread_t *thread, DXFG_OUT dxfg_v4_cfi_t **emptyCfi)
int32_t dxfg_v4_CFI_valueOf (graal_isolatethread_t *thread, const char *code, DXFG_OUT dxfg_v4_cfi_t **cfi)
int32_t dxfg_v4_CFI_valueOfIntCode (graal_isolatethread_t *thread, int32_t intCode, DXFG_OUT dxfg_v4_cfi_t **cfi)
int32_t dxfg_v4_CFI_getCode (graal_isolatethread_t *thread, dxfg_v4_cfi_t *cfi, DXFG_OUT char **code)
int32_t dxfg_v4_CFI_getIntCode (graal_isolatethread_t *thread, dxfg_v4_cfi_t *cfi, DXFG_OUT int32_t *intCode)
int32_t dxfg_v4_CFI_getCategory (graal_isolatethread_t *thread, dxfg_v4_cfi_t *cfi, DXFG_OUT int16_t *category)
int32_t dxfg_v4_CFI_getGroup (graal_isolatethread_t *thread, dxfg_v4_cfi_t *cfi, DXFG_OUT int16_t *group)
int32_t dxfg_v4_CFI_isEquity (graal_isolatethread_t *thread, dxfg_v4_cfi_t *cfi, DXFG_OUT int32_t *isEquity)
int32_t dxfg_v4_CFI_isDebtInstrument (graal_isolatethread_t *thread, dxfg_v4_cfi_t *cfi, DXFG_OUT int32_t *isDebtInstrument)
int32_t dxfg_v4_CFI_isEntitlement (graal_isolatethread_t *thread, dxfg_v4_cfi_t *cfi, DXFG_OUT int32_t *isEntitlement)
int32_t dxfg_v4_CFI_isOption (graal_isolatethread_t *thread, dxfg_v4_cfi_t *cfi, DXFG_OUT int32_t *isOption)
int32_t dxfg_v4_CFI_isFuture (graal_isolatethread_t *thread, dxfg_v4_cfi_t *cfi, DXFG_OUT int32_t *isFuture)
int32_t dxfg_v4_CFI_isOther (graal_isolatethread_t *thread, dxfg_v4_cfi_t *cfi, DXFG_OUT int32_t *isOther)
int32_t dxfg_v4_CFI_decipher (graal_isolatethread_t *thread, dxfg_v4_cfi_t *cfi, DXFG_OUT dxfg_v4_cfi_value_list **values)
int32_t dxfg_v4_CFI_describe (graal_isolatethread_t *thread, dxfg_v4_cfi_t *cfi, DXFG_OUT char **description)
int32_t dxfg_v4_CFI_Attribute_getName (graal_isolatethread_t *thread, dxfg_v4_cfi_attribute_t *cfiAttribute, DXFG_OUT char **name)
int32_t dxfg_v4_CFI_Attribute_getDescription (graal_isolatethread_t *thread, dxfg_v4_cfi_attribute_t *cfiAttribute, DXFG_OUT char **description)
int32_t dxfg_v4_CFI_Attribute_getValues (graal_isolatethread_t *thread, dxfg_v4_cfi_attribute_t *cfiAttribute, DXFG_OUT dxfg_v4_cfi_value_list **values)
int32_t dxfg_v4_CFI_Value_getAttribute (graal_isolatethread_t *thread, dxfg_v4_cfi_value_t *cfiValue, DXFG_OUT dxfg_v4_cfi_attribute_t **attribute)
int32_t dxfg_v4_CFI_Value_getCode (graal_isolatethread_t *thread, dxfg_v4_cfi_value_t *cfiValue, DXFG_OUT int16_t *code)
int32_t dxfg_v4_CFI_Value_getName (graal_isolatethread_t *thread, dxfg_v4_cfi_value_t *cfiValue, DXFG_OUT char **name)
int32_t dxfg_v4_CFI_Value_getDescription (graal_isolatethread_t *thread, dxfg_v4_cfi_value_t *cfiValue, DXFG_OUT char **description)
int32_t dxfg_v4_PriceIncrements_EMPTY (graal_isolatethread_t *thread, DXFG_OUT dxfg_v4_price_increments_t **emptyPriceIncrements)
int32_t dxfg_v4_PriceIncrements_valueOf (graal_isolatethread_t *thread, const char *text, DXFG_OUT dxfg_v4_price_increments_t **priceIncrements)
int32_t dxfg_v4_PriceIncrements_valueOfIncrement (graal_isolatethread_t *thread, double increment, DXFG_OUT dxfg_v4_price_increments_t **priceIncrements)
int32_t dxfg_v4_PriceIncrements_valueOfIncrements (graal_isolatethread_t *thread, const dxfg_v4_double_list *increments, DXFG_OUT dxfg_v4_price_increments_t **priceIncrements)
int32_t dxfg_v4_PriceIncrements_getText (graal_isolatethread_t *thread, dxfg_v4_price_increments_t *priceIncrements, DXFG_OUT char **text)
int32_t dxfg_v4_PriceIncrements_getPriceIncrements (graal_isolatethread_t *thread, dxfg_v4_price_increments_t *priceIncrements, DXFG_OUT dxfg_v4_double_list **increments)
int32_t dxfg_v4_PriceIncrements_getPriceIncrement (graal_isolatethread_t *thread, dxfg_v4_price_increments_t *priceIncrements, DXFG_OUT double *priceIncrement)
int32_t dxfg_v4_PriceIncrements_getPriceIncrementForPrice (graal_isolatethread_t *thread, dxfg_v4_price_increments_t *priceIncrements, double price, DXFG_OUT double *priceIncrement)
int32_t dxfg_v4_PriceIncrements_getPriceIncrementForPriceAndDirection (graal_isolatethread_t *thread, dxfg_v4_price_increments_t *priceIncrements, double price, int32_t direction, DXFG_OUT double *priceIncrement)
int32_t dxfg_v4_PriceIncrements_getPricePrecision (graal_isolatethread_t *thread, dxfg_v4_price_increments_t *priceIncrements, DXFG_OUT int32_t *pricePrecision)
int32_t dxfg_v4_PriceIncrements_getPricePrecisionForPrice (graal_isolatethread_t *thread, dxfg_v4_price_increments_t *priceIncrements, double price, DXFG_OUT int32_t *pricePrecision)
int32_t dxfg_v4_PriceIncrements_roundPrice (graal_isolatethread_t *thread, dxfg_v4_price_increments_t *priceIncrements, double price, DXFG_OUT double *roundedPrice)
int32_t dxfg_v4_PriceIncrements_roundPriceWithDirection (graal_isolatethread_t *thread, dxfg_v4_price_increments_t *priceIncrements, double price, int32_t direction, DXFG_OUT double *roundedPrice)
int32_t dxfg_v4_PriceIncrements_roundPriceWithRoundingMode (graal_isolatethread_t *thread, dxfg_v4_price_increments_t *priceIncrements, double price, dxfg_v4_rounding_mode_t roundingMode, DXFG_OUT double *roundedPrice)
int32_t dxfg_v4_PriceIncrements_incrementPrice (graal_isolatethread_t *thread, dxfg_v4_price_increments_t *priceIncrements, double price, int32_t direction, DXFG_OUT double *incrementedPrice)
int32_t dxfg_v4_PriceIncrements_incrementPriceWithStep (graal_isolatethread_t *thread, dxfg_v4_price_increments_t *priceIncrements, double price, int32_t direction, double step, DXFG_OUT double *incrementedPrice)
int32_t dxfg_v4_double_list_release (graal_isolatethread_t *thread, dxfg_v4_double_list *list)
int32_t dxfg_v4_string_to_double_map_entry_list_release (graal_isolatethread_t *thread, dxfg_v4_string_to_double_map_entry_list *list)
int32_t dxfg_v4_cfi_value_list_release (graal_isolatethread_t *thread, dxfg_v4_cfi_value_list *values)

Detailed Description

The v4 functions and type names of the group Glossary. Every function returns DXFG_EXECUTE_SUCCESSFULLY or DXFG_EXECUTE_FAIL and writes its result to a DXFG_OUT parameter, see The v4 functions.

Typedef Documentation

◆ dxfg_v4_additional_underlyings_t

◆ dxfg_v4_cfi_attribute_t

◆ dxfg_v4_cfi_t

A handle of a wrapper class for Classification of Financial Instruments code as defined in ISO 10962 standard. Main purpose is to provide code validity checks and to construct textual explanation of CFI code as defined in the standard via API. This handle does not provide API-accessible constants for specific instrument attributes and values.

https://en.wikipedia.org/wiki/ISO_10962 https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html

See also
CFI' functions

◆ dxfg_v4_cfi_value_list

typedef struct dxfg_v4_cfi_value_list dxfg_v4_cfi_value_list

A list of CFI value handles.

A list that a function returns (dxfg_v4_CFI_decipher(), dxfg_v4_CFI_Attribute_getValues()) is released with dxfg_v4_cfi_value_list_release(), which releases every handle of the list too.

◆ dxfg_v4_cfi_value_t

Describes single value of single character of CFI code as defined in the ISO 10962 standard.

https://en.wikipedia.org/wiki/ISO_10962 https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.Value.html

See also
CFI.Value' functions

◆ dxfg_v4_double_list

typedef struct dxfg_v4_double_list dxfg_v4_double_list

A list of doubles: the array holds the values themselves, not pointers to them.

A list that a function returns (dxfg_v4_PriceIncrements_getPriceIncrements()) is released with dxfg_v4_double_list_release(). A list that the caller passes to a function (dxfg_v4_PriceIncrements_valueOfIncrements()) is only read by it and stays with the caller.

◆ dxfg_v4_price_increments_t

Represents rules for valid price quantization for a given instrument on a certain exchange. These rules are defined as a set of price ranges with associated price increments. Each price increment defines what price values are valid for corresponding price range - valid prices shall be divisible by corresponding price increment.

All price ranges shall be mutually exclusive and they shall cover entire space from 0 to infinity. Therefore all ranges can be represented as a sequence of numbers where increments are interleaved with range limits, with extreme limits (0 and infinity) omitted for short. Negative space (from negative infinity to 0) uses symmetrical price ranges.

There is a special value EMPTY which is used to represent unknown or undefined rules. This value has empty textual representation and is considered to have sole increment with value 0.

See dxfg_PriceIncrements_getText() and dxfg_PriceIncrements_getPriceIncrements() for details about used formats and representations.

NOTE:This class produces precise results for decimal numbers with at most 14 significant digits and at most 14 digits after decimal point.

https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html

See also
PriceIncrements' functions

◆ dxfg_v4_string_to_double_map_entry_list

typedef struct dxfg_v4_string_to_double_map_entry_list dxfg_v4_string_to_double_map_entry_list

A list of string to double map entries: the array holds the entries themselves, not pointers to them.

A list that a function returns (dxfg_v4_AdditionalUnderlyings_getMap()) is released with dxfg_v4_string_to_double_map_entry_list_release(), which frees the keys too. A list that the caller passes to a function (dxfg_v4_AdditionalUnderlyings_valueOfMap()) is only read by it and stays with the caller.

Function Documentation

◆ dxfg_v4_AdditionalUnderlyings_EMPTY()

int32_t dxfg_v4_AdditionalUnderlyings_EMPTY ( graal_isolatethread_t * thread,
DXFG_OUT dxfg_v4_additional_underlyings_t ** emptyAdditionalUnderlyings )

Returns an empty additional underlyings (https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/AdditionalUnderlyings.html#EMPTY it has empty text and empty map). The handle of this instance will be written to the passed pointer.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[out]emptyAdditionalUnderlyingsThe pointer to result's handle (an empty additional underlyings https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/AdditionalUnderlyings.html#EMPTY)
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_JavaObjectHandler_release() to free the additional underlyings handle.

◆ dxfg_v4_AdditionalUnderlyings_getMap()

int32_t dxfg_v4_AdditionalUnderlyings_getMap ( graal_isolatethread_t * thread,
dxfg_v4_additional_underlyings_t * additionalUnderlyings,
DXFG_OUT dxfg_v4_string_to_double_map_entry_list ** map )

Returns internal representation of additional underlyings as a map from underlying symbol to its SPC.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]additionalUnderlyingsThe additional underlyings handle.
[out]mapThe pointer to the variable that receives the list of the map entries ([string, double] pairs; release it with dxfg_v4_string_to_double_map_entry_list_release()); must not be NULL.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/AdditionalUnderlyings.html#getMap–

◆ dxfg_v4_AdditionalUnderlyings_getSPC()

int32_t dxfg_v4_AdditionalUnderlyings_getSPC ( graal_isolatethread_t * thread,
dxfg_v4_additional_underlyings_t * additionalUnderlyings,
const char * symbol,
DXFG_OUT double * spc )

Returns SPC for specified underlying symbol or 0 is specified symbol is not found. The spc will be written to the passed pointer.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]additionalUnderlyingsThe additional underlyings handle.
[in]symbolThe symbol by which spc will be obtained.
[out]spcThe pointer to spc.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/AdditionalUnderlyings.html#getSPC-java.lang.String-

◆ dxfg_v4_AdditionalUnderlyings_getSPCFromText()

int32_t dxfg_v4_AdditionalUnderlyings_getSPCFromText ( graal_isolatethread_t * thread,
const char * text,
const char * symbol,
DXFG_OUT double * spc )

Returns SPC for specified underlying symbol or 0 is specified symbol is not found. The spc will be written to the passed pointer.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]textThe textual representation of the additional underlyings.
[in]symbolThe symbol by which spc will be obtained.
[out]spcThe pointer to spc.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/AdditionalUnderlyings.html#getSPC-java.lang.String-java.lang.String-

◆ dxfg_v4_AdditionalUnderlyings_getText()

int32_t dxfg_v4_AdditionalUnderlyings_getText ( graal_isolatethread_t * thread,
dxfg_v4_additional_underlyings_t * additionalUnderlyings,
DXFG_OUT char ** text )

Returns textual representation of additional underlyings in the format: Where UNDERLYING is a symbol of underlying instrument and SPC is a number of shares per contract of that underlying. All additional underlyings are listed in the alphabetical order of underlying symbol. In cases when option settles with additional cash the underlying symbol will specify cash symbol and SPC will specify amount of cash. The textual info will be written to the passed pointer.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]additionalUnderlyingsThe additional underlyings handle.
[out]textA pointer to the textual representation of the additional underlyings.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_String_release() to free the textual representation.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/AdditionalUnderlyings.html#getText–

◆ dxfg_v4_AdditionalUnderlyings_valueOf()

int32_t dxfg_v4_AdditionalUnderlyings_valueOf ( graal_isolatethread_t * thread,
const char * text,
DXFG_OUT dxfg_v4_additional_underlyings_t ** additionalUnderlyings )

Returns an instance of additional underlyings for specified textual representation. The handle of this instance will be written to the passed pointer.

See dxfg_v4_AdditionalUnderlyings_getText() for format specification.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]textThe textual representation.
[out]additionalUnderlyingsThe pointer to result's handle (additional underlyings for specified textual representation)
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_JavaObjectHandler_release() to free the additional underlyings handle.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/AdditionalUnderlyings.html#valueOf-java.lang.String-

◆ dxfg_v4_AdditionalUnderlyings_valueOfMap()

int32_t dxfg_v4_AdditionalUnderlyings_valueOfMap ( graal_isolatethread_t * thread,
const dxfg_v4_string_to_double_map_entry_list * map,
DXFG_OUT dxfg_v4_additional_underlyings_t ** additionalUnderlyings )

Returns an instance of additional underlyings for a map from underlying symbols to their SPC (the internal representation).

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]mapThe map entries ([string, double] pairs); the list stays with the caller. A NULL list or a list of size 0 is an empty map. A list with a positive size and NULL elements is an error.
[out]additionalUnderlyingsThe pointer to the variable that receives the additional underlyings (release it with dxfg_v4_JavaObjectHandler_release()); must not be NULL.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/AdditionalUnderlyings.html#valueOf-java.util.Map-

◆ dxfg_v4_CFI_Attribute_getDescription()

int32_t dxfg_v4_CFI_Attribute_getDescription ( graal_isolatethread_t * thread,
dxfg_v4_cfi_attribute_t * cfiAttribute,
DXFG_OUT char ** description )

Returns description of this attribute.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiAttributeThe CFI attribute handle.
[out]descriptionA pointer to the attribute description.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_String_release() to free the attribute description.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.Attribute.html#getDescription–

◆ dxfg_v4_CFI_Attribute_getName()

int32_t dxfg_v4_CFI_Attribute_getName ( graal_isolatethread_t * thread,
dxfg_v4_cfi_attribute_t * cfiAttribute,
DXFG_OUT char ** name )

Returns short name of this attribute.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiAttributeThe CFI attribute handle.
[out]nameA pointer to the attribute name.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_String_release() to free the attribute name.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.Attribute.html#getName–

◆ dxfg_v4_CFI_Attribute_getValues()

int32_t dxfg_v4_CFI_Attribute_getValues ( graal_isolatethread_t * thread,
dxfg_v4_cfi_attribute_t * cfiAttribute,
DXFG_OUT dxfg_v4_cfi_value_list ** values )

Returns values of this attribute.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiAttributeThe CFI attribute handle.
[out]valuesThe pointer to the variable that receives the list of the values (release it with dxfg_v4_cfi_value_list_release()); must not be NULL.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.Attribute.html#getValues–

◆ dxfg_v4_CFI_decipher()

int32_t dxfg_v4_CFI_decipher ( graal_isolatethread_t * thread,
dxfg_v4_cfi_t * cfi,
DXFG_OUT dxfg_v4_cfi_value_list ** values )

Returns the values that explain the meaning of each character of the CFI code. The list always has 6 elements, and each value explains the corresponding character. If certain character is inapplicable, unknown or unrecognized - corresponding value will contain reference to this fact.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiThe CFI handle.
[out]valuesThe pointer to the variable that receives the list of the values (release it with dxfg_v4_cfi_value_list_release()); must not be NULL.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#decipher–

◆ dxfg_v4_CFI_describe()

int32_t dxfg_v4_CFI_describe ( graal_isolatethread_t * thread,
dxfg_v4_cfi_t * cfi,
DXFG_OUT char ** description )

Returns short textual description of this CFI code by listing names of all values for the characters in this CFI code.

See also
dxfg_CFI_decipher method.

The code will be written to the passed pointer.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiThe CFI handle.
[out]descriptionA pointer to the description.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_String_release() to free the description.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#describe–

◆ dxfg_v4_CFI_EMPTY()

int32_t dxfg_v4_CFI_EMPTY ( graal_isolatethread_t * thread,
DXFG_OUT dxfg_v4_cfi_t ** emptyCfi )

Returns an empty CFI (it has code "XXXXXX"). (https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#EMPTY). The handle of this instance will be written to the passed pointer.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[out]emptyCfiThe pointer to result's handle (an empty CFI https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#EMPTY)
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_JavaObjectHandler_release() to free the CFI handle.

◆ dxfg_v4_CFI_getCategory()

int32_t dxfg_v4_CFI_getCategory ( graal_isolatethread_t * thread,
dxfg_v4_cfi_t * cfi,
DXFG_OUT int16_t * category )

Returns single UTF16 character for instrument category - the first character of the CFI code.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiThe CFI handle.
[out]categoryA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#getCategory–

◆ dxfg_v4_CFI_getCode()

int32_t dxfg_v4_CFI_getCode ( graal_isolatethread_t * thread,
dxfg_v4_cfi_t * cfi,
DXFG_OUT char ** code )

Returns CFI code. The code always has length of 6 characters. The code will be written to the passed pointer.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiThe CFI handle.
[out]codeA pointer to the CFI code.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_String_release() to free the CFI code.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#getCode–

◆ dxfg_v4_CFI_getGroup()

int32_t dxfg_v4_CFI_getGroup ( graal_isolatethread_t * thread,
dxfg_v4_cfi_t * cfi,
DXFG_OUT int16_t * group )

Returns single UTF16 character for instrument group - the second character of the CFI code.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiThe CFI handle.
[out]groupA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#getGroup–

◆ dxfg_v4_CFI_getIntCode()

int32_t dxfg_v4_CFI_getIntCode ( graal_isolatethread_t * thread,
dxfg_v4_cfi_t * cfi,
DXFG_OUT int32_t * intCode )

Returns integer representation of CFI code. The code will be written to the passed pointer.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiThe CFI handle.
[out]intCodeA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#getIntCode–

◆ dxfg_v4_CFI_isDebtInstrument()

int32_t dxfg_v4_CFI_isDebtInstrument ( graal_isolatethread_t * thread,
dxfg_v4_cfi_t * cfi,
DXFG_OUT int32_t * isDebtInstrument )

Returns 1 if corresponding instrument is a debt instrument, 0 otherwise.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiThe CFI handle.
[out]isDebtInstrumentA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#isDebtInstrument–

◆ dxfg_v4_CFI_isEntitlement()

int32_t dxfg_v4_CFI_isEntitlement ( graal_isolatethread_t * thread,
dxfg_v4_cfi_t * cfi,
DXFG_OUT int32_t * isEntitlement )

Returns 1 if corresponding instrument is an entitlement (right), 0 otherwise.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiThe CFI handle.
[out]isEntitlementA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#isEntitlement–

◆ dxfg_v4_CFI_isEquity()

int32_t dxfg_v4_CFI_isEquity ( graal_isolatethread_t * thread,
dxfg_v4_cfi_t * cfi,
DXFG_OUT int32_t * isEquity )

Returns 1 if corresponding instrument is an equity, 0 otherwise.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiThe CFI handle.
[out]isEquityA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#isEquity–

◆ dxfg_v4_CFI_isFuture()

int32_t dxfg_v4_CFI_isFuture ( graal_isolatethread_t * thread,
dxfg_v4_cfi_t * cfi,
DXFG_OUT int32_t * isFuture )

Returns 1 if corresponding instrument is a future, 0 otherwise.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiThe CFI handle.
[out]isFutureA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#isFuture–

◆ dxfg_v4_CFI_isOption()

int32_t dxfg_v4_CFI_isOption ( graal_isolatethread_t * thread,
dxfg_v4_cfi_t * cfi,
DXFG_OUT int32_t * isOption )

Returns 1 if corresponding instrument is an option, 0 otherwise.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiThe CFI handle.
[out]isOptionA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#isOption–

◆ dxfg_v4_CFI_isOther()

int32_t dxfg_v4_CFI_isOther ( graal_isolatethread_t * thread,
dxfg_v4_cfi_t * cfi,
DXFG_OUT int32_t * isOther )

Returns 1 if corresponding instrument is an other (miscellaneous) instrument, 0 otherwise.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiThe CFI handle.
[out]isOtherA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#isOther–

◆ dxfg_v4_CFI_Value_getAttribute()

int32_t dxfg_v4_CFI_Value_getAttribute ( graal_isolatethread_t * thread,
dxfg_v4_cfi_value_t * cfiValue,
DXFG_OUT dxfg_v4_cfi_attribute_t ** attribute )

Returns attribute that contains this value.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiValueThe CFI value handle.
[out]attributeA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_JavaObjectHandler_release() to free the attribute handle.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.Value.html#getAttribute–

◆ dxfg_v4_CFI_Value_getCode()

int32_t dxfg_v4_CFI_Value_getCode ( graal_isolatethread_t * thread,
dxfg_v4_cfi_value_t * cfiValue,
DXFG_OUT int16_t * code )

Returns single UTF16 character code of this value.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiValueThe CFI value handle.
[out]codeA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.Value.html#getCode–

◆ dxfg_v4_CFI_Value_getDescription()

int32_t dxfg_v4_CFI_Value_getDescription ( graal_isolatethread_t * thread,
dxfg_v4_cfi_value_t * cfiValue,
DXFG_OUT char ** description )

Returns description of this value.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiValueThe CFI value handle.
[out]descriptionA pointer to the value description.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_String_release() to free the value description.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.Value.html#getDescription–

◆ dxfg_v4_CFI_Value_getName()

int32_t dxfg_v4_CFI_Value_getName ( graal_isolatethread_t * thread,
dxfg_v4_cfi_value_t * cfiValue,
DXFG_OUT char ** name )

Returns short name of this value.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]cfiValueThe CFI value handle.
[out]nameA pointer to the value name.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_String_release() to free the value name.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.Value.html#getName–

◆ dxfg_v4_cfi_value_list_release()

int32_t dxfg_v4_cfi_value_list_release ( graal_isolatethread_t * thread,
dxfg_v4_cfi_value_list * values )

Releases a list of CFI values that a function returned (dxfg_v4_CFI_decipher(), dxfg_v4_CFI_Attribute_getValues()): releases every CFI value handle, frees the array of the handles and the list itself. To keep a value after that, clone its handle first with dxfg_v4_JavaObjectHandler_clone().

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]valuesThe list to release. If it is NULL, nothing is done.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.

◆ dxfg_v4_CFI_valueOf()

int32_t dxfg_v4_CFI_valueOf ( graal_isolatethread_t * thread,
const char * code,
DXFG_OUT dxfg_v4_cfi_t ** cfi )

Returns an instance of CFI for specified CFI code. (https://en.wikipedia.org/wiki/ISO_10962) Accepts short code and expands it to 6 letters by appending "X" at the end. The handle of this instance will be written to the passed pointer.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]codeThe CFI code.
[out]cfiThe pointer to result's handle (for specified CFI code)
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_JavaObjectHandler_release() to free the CFI handle.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#valueOf-java.lang.String-

◆ dxfg_v4_CFI_valueOfIntCode()

int32_t dxfg_v4_CFI_valueOfIntCode ( graal_isolatethread_t * thread,
int32_t intCode,
DXFG_OUT dxfg_v4_cfi_t ** cfi )

Returns an instance of CFI for specified integer representation of CFI code. The handle of this instance will be written to the passed pointer.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]intCodeThe integer representation of CFI code.
[out]cfiThe pointer to result's handle (for specified CFI code)
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_JavaObjectHandler_release() to free the CFI handle.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/CFI.html#valueOf-int-

◆ dxfg_v4_double_list_release()

int32_t dxfg_v4_double_list_release ( graal_isolatethread_t * thread,
dxfg_v4_double_list * list )

Releases a list of doubles that a function returned (dxfg_v4_PriceIncrements_getPriceIncrements()): frees the array of the values and the list itself.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]listThe list to release. If it is NULL, nothing is done.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.

◆ dxfg_v4_PriceIncrements_EMPTY()

int32_t dxfg_v4_PriceIncrements_EMPTY ( graal_isolatethread_t * thread,
DXFG_OUT dxfg_v4_price_increments_t ** emptyPriceIncrements )

Returns an empty price increments - it has empty text and sole increment with value 0. The handle of this instance will be written to the passed pointer.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[out]emptyPriceIncrementsThe pointer to result's handle.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_JavaObjectHandler_release() to free the price increments handle.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#EMPTY

◆ dxfg_v4_PriceIncrements_getPriceIncrement()

int32_t dxfg_v4_PriceIncrements_getPriceIncrement ( graal_isolatethread_t * thread,
dxfg_v4_price_increments_t * priceIncrements,
DXFG_OUT double * priceIncrement )

Returns first price increment (for price range adjacent to 0), usually the smallest one. Returns 0 for EMPTY price increments.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]priceIncrementsThe price increments handle.
[out]priceIncrementA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#getPriceIncrement–

◆ dxfg_v4_PriceIncrements_getPriceIncrementForPrice()

int32_t dxfg_v4_PriceIncrements_getPriceIncrementForPrice ( graal_isolatethread_t * thread,
dxfg_v4_price_increments_t * priceIncrements,
double price,
DXFG_OUT double * priceIncrement )

Returns price increment which shall be applied to the specified price. If price is Not-a-Number (NaN) then first price increment is returned. If price is a breakpoint between two ranges then minimum of upward and downward increments is returned. This method is equivalent to calling dxfg_PriceIncrements_getPriceIncrement3(thread, price_increments, price, 0, &price_increment).

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]priceIncrementsThe price increments handle.
[in]priceThe price.
[out]priceIncrementA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#getPriceIncrement-double-

◆ dxfg_v4_PriceIncrements_getPriceIncrementForPriceAndDirection()

int32_t dxfg_v4_PriceIncrements_getPriceIncrementForPriceAndDirection ( graal_isolatethread_t * thread,
dxfg_v4_price_increments_t * priceIncrements,
double price,
int32_t direction,
DXFG_OUT double * priceIncrement )

Returns price increment which shall be applied to the specified price in the specified direction. If price is Not-a-Number (NaN) then first price increment is returned. If price is a breakpoint between two ranges and direction is 0 then minimum of upward and downward increments is returned.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]priceIncrementsThe price increments handle.
[in]priceThe price.
[in]directionThe direction.
[out]priceIncrementA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#getPriceIncrement-double-int-

◆ dxfg_v4_PriceIncrements_getPriceIncrements()

int32_t dxfg_v4_PriceIncrements_getPriceIncrements ( graal_isolatethread_t * thread,
dxfg_v4_price_increments_t * priceIncrements,
DXFG_OUT dxfg_v4_double_list ** increments )

Returns internal representation of price increments as a single list of double values. This list specifies all numbers from textual representation (see dxfg_v4_PriceIncrements_getText()) in the same order. Therefore numbers at even positions are increments and numbers at odd positions are upper limits. The list always has odd length - the infinite upper limit of last range is always omitted and the first increment (for price range adjacent to 0) is always included even for EMPTY value.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]priceIncrementsThe price increments handle.
[out]incrementsThe pointer to the variable that receives the list of the values (release it with dxfg_v4_double_list_release()); must not be NULL.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#getPriceIncrements–

◆ dxfg_v4_PriceIncrements_getPricePrecision()

int32_t dxfg_v4_PriceIncrements_getPricePrecision ( graal_isolatethread_t * thread,
dxfg_v4_price_increments_t * priceIncrements,
DXFG_OUT int32_t * pricePrecision )

Returns first price precision (for price range adjacent to 0), usually the largest one. Returns 0 for EMPTY price increments.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]priceIncrementsThe price increments handle.
[out]pricePrecisionA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#getPricePrecision–

◆ dxfg_v4_PriceIncrements_getPricePrecisionForPrice()

int32_t dxfg_v4_PriceIncrements_getPricePrecisionForPrice ( graal_isolatethread_t * thread,
dxfg_v4_price_increments_t * priceIncrements,
double price,
DXFG_OUT int32_t * pricePrecision )

Returns price precision for the price range which contains specified price. Price precision is a number of decimal digits after decimal point that are needed to represent all valid prices in the given price range. This method returns price precision in the interval [0, 18] inclusive. If price is Not-a-Number (NaN) then first price precision is returned. If price is a breakpoint between two ranges then precision of lower range is returned.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]priceIncrementsThe price increments handle.
[in]priceThe price.
[out]pricePrecisionA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#getPricePrecision-double-

◆ dxfg_v4_PriceIncrements_getText()

int32_t dxfg_v4_PriceIncrements_getText ( graal_isolatethread_t * thread,
dxfg_v4_price_increments_t * priceIncrements,
DXFG_OUT char ** text )

Returns textual representation of price increments in the format:

TEXT ::= "" | LIST
LIST ::= INCREMENT | RANGE "; " LIST
RANGE ::= INCREMENT " " UPPER_LIMIT

Where INCREMENT is a price increment in the given price range and UPPER_LIMIT is the upper bound of that range. All ranges are listed in the ascending order of upper limits and the last range is considered to extend toward infinity and is therefore specified without upper limit. All increments and limits are finite positive numbers. The case with empty text is a special stub used for EMPTY value, it uses sole increment with value 0.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]priceIncrementsThe price increments handle.
[out]textA pointer to the textual representation of the price increments.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_String_release() to free the textual representation.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#getText–

◆ dxfg_v4_PriceIncrements_incrementPrice()

int32_t dxfg_v4_PriceIncrements_incrementPrice ( graal_isolatethread_t * thread,
dxfg_v4_price_increments_t * priceIncrements,
double price,
int32_t direction,
DXFG_OUT double * incrementedPrice )

Returns specified price incremented in the specified direction by appropriate increment and then rounded to nearest valid value. If price is Not-a-Number (NaN) then NaN is returned. If appropriate price increment is 0 then specified price is returned as is. This method is equivalent to calling dxfg_PriceIncrements_incrementPrice2(thread, priceIncrements, price, direction, 0, &incrementedPrice).

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]priceIncrementsThe price increments handle.
[in]priceThe price.
[in]directionThe direction.
[out]incrementedPriceA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Throws IllegalArgumentException if direction is 0. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#incrementPrice-double-int-

◆ dxfg_v4_PriceIncrements_incrementPriceWithStep()

int32_t dxfg_v4_PriceIncrements_incrementPriceWithStep ( graal_isolatethread_t * thread,
dxfg_v4_price_increments_t * priceIncrements,
double price,
int32_t direction,
double step,
DXFG_OUT double * incrementedPrice )

Returns specified price incremented in the specified direction by the maximum of specified step and appropriate increment, and then rounded to nearest valid value. If price is Not-a-Number (NaN) then NaN is returned. If both step and appropriate price increment are 0 then specified price is returned as is. Note that step must be positive even for negative directions.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]priceIncrementsThe price increments handle.
[in]priceThe price.
[in]directionThe direction.
[in]stepThe step.
[out]incrementedPriceA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Throws IllegalArgumentException if direction is 0 or step uses invalid value. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#incrementPrice-double-int-double-

◆ dxfg_v4_PriceIncrements_roundPrice()

int32_t dxfg_v4_PriceIncrements_roundPrice ( graal_isolatethread_t * thread,
dxfg_v4_price_increments_t * priceIncrements,
double price,
DXFG_OUT double * roundedPrice )

Returns specified price rounded to nearest valid value. If price is Not-a-Number (NaN) then NaN is returned. If appropriate price increment is 0 then specified price is returned as is. This method is equivalent to calling dxfg_PriceIncrements_roundPrice2(isolate_thread, price_increments, price, 0, &rounded_price).

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]priceIncrementsThe price increments handle.
[in]priceThe price.
[out]roundedPriceA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#roundPrice-double-

◆ dxfg_v4_PriceIncrements_roundPriceWithDirection()

int32_t dxfg_v4_PriceIncrements_roundPriceWithDirection ( graal_isolatethread_t * thread,
dxfg_v4_price_increments_t * priceIncrements,
double price,
int32_t direction,
DXFG_OUT double * roundedPrice )

Returns specified price rounded in the specified direction to nearest value that is valid according to price increment rules. If price is Not-a-Number (NaN) then NaN is returned. If appropriate price increment is 0 then specified price is returned as is. If direction is 0 then price is rounded to nearest valid value.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]priceIncrementsThe price increments handle.
[in]priceThe price.
[in]directionThe direction.
[out]roundedPriceA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#roundPrice-double-int-

◆ dxfg_v4_PriceIncrements_roundPriceWithRoundingMode()

int32_t dxfg_v4_PriceIncrements_roundPriceWithRoundingMode ( graal_isolatethread_t * thread,
dxfg_v4_price_increments_t * priceIncrements,
double price,
dxfg_v4_rounding_mode_t roundingMode,
DXFG_OUT double * roundedPrice )

Returns specified price rounded according to specified rounding mode to nearest value that is valid according to price increment rules. If price is Not-a-Number (NaN) then NaN is returned. If appropriate price increment is 0 then specified price is returned as is.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]priceIncrementsThe price increments handle.
[in]priceThe price.
[in]roundingModeThe rounding mode.
[out]roundedPriceA pointer to the result.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#roundPrice-double-java.math.RoundingMode-

◆ dxfg_v4_PriceIncrements_valueOf()

int32_t dxfg_v4_PriceIncrements_valueOf ( graal_isolatethread_t * thread,
const char * text,
DXFG_OUT dxfg_v4_price_increments_t ** priceIncrements )

Returns an instance of price increments for specified textual representation. The handle of this instance will be written to the passed pointer.

See dxfg_v4_PriceIncrements_getText() for format specification.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]textThe textual representation.
[out]priceIncrementsThe pointer to result's handle (price increments for specified textual representation)
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_JavaObjectHandler_release() to free the price increments handle.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#valueOf-java.lang.String-

◆ dxfg_v4_PriceIncrements_valueOfIncrement()

int32_t dxfg_v4_PriceIncrements_valueOfIncrement ( graal_isolatethread_t * thread,
double increment,
DXFG_OUT dxfg_v4_price_increments_t ** priceIncrements )

Returns an instance of price increments for specified single increment.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]incrementThe single increment.
[out]priceIncrementsThe pointer to result's handle.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown. Use dxfg_v4_JavaObjectHandler_release() to free the price increments handle.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#valueOf-double-

◆ dxfg_v4_PriceIncrements_valueOfIncrements()

int32_t dxfg_v4_PriceIncrements_valueOfIncrements ( graal_isolatethread_t * thread,
const dxfg_v4_double_list * increments,
DXFG_OUT dxfg_v4_price_increments_t ** priceIncrements )

Returns an instance of price increments for specified internal representation. See dxfg_v4_PriceIncrements_getPriceIncrements() for details about internal representation.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]incrementsThe increments in internal representation; the list stays with the caller. A NULL list or a list of size 0 gives EMPTY. A list with a positive size and NULL elements is an error.
[out]priceIncrementsThe pointer to the variable that receives the price increments (release it with dxfg_v4_JavaObjectHandler_release()); must not be NULL.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.
See also
https://docs.dxfeed.com/dxfeed/api/com/dxfeed/glossary/PriceIncrements.html#valueOf-double:A-

◆ dxfg_v4_string_to_double_map_entry_list_release()

int32_t dxfg_v4_string_to_double_map_entry_list_release ( graal_isolatethread_t * thread,
dxfg_v4_string_to_double_map_entry_list * list )

Releases a list of string to double map entries that a function returned (dxfg_v4_AdditionalUnderlyings_getMap()): frees the key of every entry, the array of the entries and the list itself.

Parameters
[in]threadThe current GraalVM Isolate's thread.
[in]listThe list to release. If it is NULL, nothing is done.
Returns
DXFG_EXECUTE_SUCCESSFULLY (0) on successful function execution or DXFG_EXECUTE_FAIL (-1) on error. Use dxfg_v4_get_and_clear_thread_exception() to determine if an exception was thrown.