dxFeed .Net API  7.1.0
dxFeed .Net API library intended to provide market data access for DX clients
com.dxfeed.ipf.InstrumentProfileField Class Reference

Defines standard fields of InstrumentProfile and provides data access methods. Please see Instrument Profile Format documentation for complete description. More...

Collaboration diagram for com.dxfeed.ipf.InstrumentProfileField:
[legend]

Public Member Functions

override string ToString ()
 Returns string representation of field. More...
 
string GetField (InstrumentProfile ip)
 Returns value of this field for specified profile in textual representation. More...
 
void SetField (InstrumentProfile ip, string value)
 Sets value of this field (in textual representation) to specified profile. More...
 
Type GetFieldType ()
 Returns type of this field. More...
 
bool IsNumericField ()
 Returns "true" if this field supports numeric representation of a value. More...
 
double GetNumericField (InstrumentProfile ip)
 Returns value of this field for specified profile in numeric representation. More...
 
void SetNumericField (InstrumentProfile ip, double value)
 Sets value of this field (in numeric representation) to specified profile. More...
 

Static Public Member Functions

static InstrumentProfileField Find (string name)
 Returns field for specified name or null if field is not found. More...
 
static string FormatNumber (double d)
 Format number More...
 
static double ParseNumber (string s)
 Parse number from string. More...
 
static string FormatDate (int d)
 Convert unix time to specified date fromat and returns its string representation. More...
 
static int ParseDate (string s)
 Parse date from string. More...
 

Static Public Attributes

static readonly InstrumentProfileField TYPE = new InstrumentProfileField(F_TYPE)
 
static readonly InstrumentProfileField SYMBOL = new InstrumentProfileField(F_SYMBOL)
 
static readonly InstrumentProfileField DESCRIPTION = new InstrumentProfileField(F_DESCRIPTION)
 
static readonly InstrumentProfileField LOCAL_SYMBOL = new InstrumentProfileField(F_LOCAL_SYMBOL)
 
static readonly InstrumentProfileField LOCAL_DESCRIPTION = new InstrumentProfileField(F_LOCAL_DESCRIPTION)
 
static readonly InstrumentProfileField COUNTRY = new InstrumentProfileField(F_COUNTRY)
 
static readonly InstrumentProfileField OPOL = new InstrumentProfileField(F_OPOL)
 
static readonly InstrumentProfileField EXCHANGE_DATA = new InstrumentProfileField(F_EXCHANGE_DATA)
 
static readonly InstrumentProfileField EXCHANGES = new InstrumentProfileField(F_EXCHANGES)
 
static readonly InstrumentProfileField CURRENCY = new InstrumentProfileField(F_CURRENCY)
 
static readonly InstrumentProfileField BASE_CURRENCY = new InstrumentProfileField(F_BASE_CURRENCY)
 
static readonly InstrumentProfileField CFI = new InstrumentProfileField(F_CFI)
 
static readonly InstrumentProfileField ISIN = new InstrumentProfileField(F_ISIN)
 
static readonly InstrumentProfileField SEDOL = new InstrumentProfileField(F_SEDOL)
 
static readonly InstrumentProfileField CUSIP = new InstrumentProfileField(F_CUSIP)
 
static readonly InstrumentProfileField ICB = new InstrumentProfileField(F_ICB)
 
static readonly InstrumentProfileField SIC = new InstrumentProfileField(F_SIC)
 
static readonly InstrumentProfileField MULTIPLIER = new InstrumentProfileField(F_MULTIPLIER)
 
static readonly InstrumentProfileField PRODUCT = new InstrumentProfileField(F_PRODUCT)
 
static readonly InstrumentProfileField UNDERLYING = new InstrumentProfileField(F_UNDERLYING)
 
static readonly InstrumentProfileField SPC = new InstrumentProfileField(F_SPC)
 
static readonly InstrumentProfileField ADDITIONAL_UNDERLYINGS = new InstrumentProfileField(F_ADDITIONAL_UNDERLYINGS)
 
static readonly InstrumentProfileField MMY = new InstrumentProfileField(F_MMY)
 
static readonly InstrumentProfileField EXPIRATION = new InstrumentProfileField(F_EXPIRATION)
 
static readonly InstrumentProfileField LAST_TRADE = new InstrumentProfileField(F_LAST_TRADE)
 
static readonly InstrumentProfileField STRIKE = new InstrumentProfileField(F_STRIKE)
 
static readonly InstrumentProfileField OPTION_TYPE = new InstrumentProfileField(F_OPTION_TYPE)
 
static readonly InstrumentProfileField EXPIRATION_STYLE = new InstrumentProfileField(F_EXPIRATION_STYLE)
 
static readonly InstrumentProfileField SETTLEMENT_STYLE = new InstrumentProfileField(F_SETTLEMENT_STYLE)
 
static readonly InstrumentProfileField PRICE_INCREMENTS = new InstrumentProfileField(F_PRICE_INCREMENTS)
 
static readonly InstrumentProfileField TRADING_HOURS = new InstrumentProfileField(F_TRADING_HOURS)
 

Properties

string Name [get]
 Get name of instrument profile field. More...
 
static InstrumentProfileField [] Values [get]
 Get all default instrument profile fields. More...
 

Detailed Description

Defines standard fields of InstrumentProfile and provides data access methods. Please see Instrument Profile Format documentation for complete description.

Member Function Documentation

◆ Find()

static InstrumentProfileField com.dxfeed.ipf.InstrumentProfileField.Find ( string  name)
inlinestatic

Returns field for specified name or null if field is not found.

Parameters
nameName of field to find.
Returns
Field for specified name or null if field is not found.
Exceptions
System.ArgumentNullExceptionIf name is null.

◆ FormatDate()

static string com.dxfeed.ipf.InstrumentProfileField.FormatDate ( int  d)
inlinestatic

Convert unix time to specified date fromat and returns its string representation.

Parameters
dDate time in unix time.
Returns
String representation of date tinme.
Exceptions
System.FormatException
System.InvalidOperationExceptionIf number formatter error occurs.

◆ FormatNumber()

static string com.dxfeed.ipf.InstrumentProfileField.FormatNumber ( double  d)
inlinestatic

Format number

Parameters
dThe number to format.
Returns
Strig representation of number in specified format.
Exceptions
System.InvalidOperationExceptionCan't format number.

◆ GetField()

string com.dxfeed.ipf.InstrumentProfileField.GetField ( InstrumentProfile  ip)
inline

Returns value of this field for specified profile in textual representation.

Parameters
ipProfile fot which get field.
Returns
Value of this field for specified profile in textual representation.
Exceptions
System.InvalidOperationExceptionCan't format certain field.

◆ GetFieldType()

Type com.dxfeed.ipf.InstrumentProfileField.GetFieldType ( )
inline

Returns type of this field.

Returns
Type of this field.

◆ GetNumericField()

double com.dxfeed.ipf.InstrumentProfileField.GetNumericField ( InstrumentProfile  ip)
inline

Returns value of this field for specified profile in numeric representation.

Parameters
ipProfile from get field.
Returns
Value of this field for specified profile in numeric representation.
Exceptions
System.ArgumentExceptionIf this field has no numeric representation.

◆ IsNumericField()

bool com.dxfeed.ipf.InstrumentProfileField.IsNumericField ( )
inline

Returns "true" if this field supports numeric representation of a value.

Returns
"true" if this field supports numeric representation of a value.

◆ ParseDate()

static int com.dxfeed.ipf.InstrumentProfileField.ParseDate ( string  s)
inlinestatic

Parse date from string.

Parameters
sString representation of date.
Returns
Exceptions
System.ArgumentNullException
System.InvalidOperationExceptionIf number formatter error occurs.
System.FormatException

◆ ParseNumber()

static double com.dxfeed.ipf.InstrumentProfileField.ParseNumber ( string  s)
inlinestatic

Parse number from string.

Parameters
sString representation of number.
Returns
Double number.
Exceptions
System.ArgumentNullException
System.FormatException

◆ SetField()

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

Sets value of this field (in textual representation) to specified profile.

Parameters
ipProfile to set field.
valueValue that set into field.
Exceptions
System.InvalidOperationExceptionIf text uses wrong format or contains invalid values.

◆ SetNumericField()

void com.dxfeed.ipf.InstrumentProfileField.SetNumericField ( InstrumentProfile  ip,
double  value 
)
inline

Sets value of this field (in numeric representation) to specified profile.

Parameters
ipProfile tos set value.
valueValue ehich set to field.
Exceptions
System.ArgumentExceptionIf this field has no numeric representation

◆ ToString()

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

Returns string representation of field.

Returns
String representation of field.

Property Documentation

◆ Name

string com.dxfeed.ipf.InstrumentProfileField.Name
get

Get name of instrument profile field.

◆ Values

InstrumentProfileField [] com.dxfeed.ipf.InstrumentProfileField.Values
staticget

Get all default instrument profile fields.


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