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

Defines standard types of InstrumentProfile. Note that other (unknown) types can be used without listing in this class - use it for convenience only. Please see Instrument Profile Format documentation for complete description. More...

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

Public Member Functions

int CompareTo (InstrumentProfileType other)
 Compare this type with other. More...
 

Static Public Member Functions

static InstrumentProfileType Find (string name)
 Returns field for specified name or null if field is not found. More...
 
static int CompareTypes (string type1, string type2)
 Compares two specified types 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...
 

Static Public Attributes

static readonly InstrumentProfileType CURRENCY = new InstrumentProfileType(T_CURRENCY)
 
static readonly InstrumentProfileType FOREX = new InstrumentProfileType(T_FOREX)
 
static readonly InstrumentProfileType BOND = new InstrumentProfileType(T_BOND)
 
static readonly InstrumentProfileType INDEX = new InstrumentProfileType(T_INDEX)
 
static readonly InstrumentProfileType STOCK = new InstrumentProfileType(T_STOCK)
 
static readonly InstrumentProfileType ETF = new InstrumentProfileType(T_ETF)
 
static readonly InstrumentProfileType MUTUAL_FUND = new InstrumentProfileType(T_MUTUAL_FUND)
 
static readonly InstrumentProfileType MONEY_MARKET_FUND = new InstrumentProfileType(T_MONEY_MARKET_FUND)
 
static readonly InstrumentProfileType PRODUCT = new InstrumentProfileType(T_PRODUCT)
 
static readonly InstrumentProfileType FUTURE = new InstrumentProfileType(T_FUTURE)
 
static readonly InstrumentProfileType OPTION = new InstrumentProfileType(T_OPTION)
 
static readonly InstrumentProfileType SPREAD = new InstrumentProfileType(T_SPREAD)
 
static readonly InstrumentProfileType OTHER = new InstrumentProfileType(T_OTHER)
 
static readonly InstrumentProfileType REMOVED = new InstrumentProfileType(T_REMOVED)
 

Properties

string Name [get]
 Get the name of instrument profile type. More...
 

Detailed Description

Defines standard types of InstrumentProfile. Note that other (unknown) types can be used without listing in this class - use it for convenience only. Please see Instrument Profile Format documentation for complete description.

Member Function Documentation

◆ CompareTo()

int com.dxfeed.ipf.InstrumentProfileType.CompareTo ( InstrumentProfileType  other)
inline

Compare this type with other.

Parameters
otherOther type to compare.
Returns

◆ CompareTypes()

static int com.dxfeed.ipf.InstrumentProfileType.CompareTypes ( string  type1,
string  type2 
)
inlinestatic

Compares two specified types 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.

Unlike natual ordering of InstrumentProfileType enum itself this method supports unknown types and orders them alphabetically after standard ones.

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
type1First type to compare.
type2Second type to compare.
Returns
Exceptions
System.ArgumentNullException

◆ Find()

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

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

Parameters
nameName of type.
Returns
Field for specified name or null if field is not found.
Exceptions
System.ArgumentNullException

Property Documentation

◆ Name

string com.dxfeed.ipf.InstrumentProfileType.Name
get

Get the name of instrument profile type.


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