dxFeed .Net API  5.8.0
dxFeed .Net API library intended to provide market data access for DX clients
Public Member Functions | Static Public Member Functions | Static Public Attributes | Properties | Private Member Functions | Private Attributes | Static Private Attributes
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, private set]
 Get the name of instrument profile type. More...
 

Private Member Functions

 InstrumentProfileType (string name)
 

Private Attributes

const string T_CURRENCY = "CURRENCY"
 
const string T_FOREX = "FOREX"
 
const string T_BOND = "BOND"
 
const string T_INDEX = "INDEX"
 
const string T_STOCK = "STOCK"
 
const string T_ETF = "ETF"
 
const string T_MUTUAL_FUND = "MUTUAL_FUND"
 
const string T_MONEY_MARKET_FUND = "MONEY_MARKET_FUND"
 
const string T_PRODUCT = "PRODUCT"
 
const string T_FUTURE = "FUTURE"
 
const string T_OPTION = "OPTION"
 
const string T_SPREAD = "SPREAD"
 
const string T_OTHER = "OTHER"
 
const string T_REMOVED = "REMOVED"
 

Static Private Attributes

static Dictionary< string, InstrumentProfileTypetypesMap = new Dictionary<string, InstrumentProfileType>()
 

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.

Constructor & Destructor Documentation

◆ InstrumentProfileType()

com.dxfeed.ipf.InstrumentProfileType.InstrumentProfileType ( string  name)
inlineprivate

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

Field Documentation

◆ BOND

readonly InstrumentProfileType com.dxfeed.ipf.InstrumentProfileType.BOND = new InstrumentProfileType(T_BOND)
static

◆ CURRENCY

readonly InstrumentProfileType com.dxfeed.ipf.InstrumentProfileType.CURRENCY = new InstrumentProfileType(T_CURRENCY)
static

◆ ETF

readonly InstrumentProfileType com.dxfeed.ipf.InstrumentProfileType.ETF = new InstrumentProfileType(T_ETF)
static

◆ FOREX

readonly InstrumentProfileType com.dxfeed.ipf.InstrumentProfileType.FOREX = new InstrumentProfileType(T_FOREX)
static

◆ FUTURE

readonly InstrumentProfileType com.dxfeed.ipf.InstrumentProfileType.FUTURE = new InstrumentProfileType(T_FUTURE)
static

◆ INDEX

readonly InstrumentProfileType com.dxfeed.ipf.InstrumentProfileType.INDEX = new InstrumentProfileType(T_INDEX)
static

◆ MONEY_MARKET_FUND

readonly InstrumentProfileType com.dxfeed.ipf.InstrumentProfileType.MONEY_MARKET_FUND = new InstrumentProfileType(T_MONEY_MARKET_FUND)
static

◆ MUTUAL_FUND

readonly InstrumentProfileType com.dxfeed.ipf.InstrumentProfileType.MUTUAL_FUND = new InstrumentProfileType(T_MUTUAL_FUND)
static

◆ OPTION

readonly InstrumentProfileType com.dxfeed.ipf.InstrumentProfileType.OPTION = new InstrumentProfileType(T_OPTION)
static

◆ OTHER

readonly InstrumentProfileType com.dxfeed.ipf.InstrumentProfileType.OTHER = new InstrumentProfileType(T_OTHER)
static

◆ PRODUCT

readonly InstrumentProfileType com.dxfeed.ipf.InstrumentProfileType.PRODUCT = new InstrumentProfileType(T_PRODUCT)
static

◆ REMOVED

readonly InstrumentProfileType com.dxfeed.ipf.InstrumentProfileType.REMOVED = new InstrumentProfileType(T_REMOVED)
static

◆ SPREAD

readonly InstrumentProfileType com.dxfeed.ipf.InstrumentProfileType.SPREAD = new InstrumentProfileType(T_SPREAD)
static

◆ STOCK

readonly InstrumentProfileType com.dxfeed.ipf.InstrumentProfileType.STOCK = new InstrumentProfileType(T_STOCK)
static

◆ T_BOND

const string com.dxfeed.ipf.InstrumentProfileType.T_BOND = "BOND"
private

◆ T_CURRENCY

const string com.dxfeed.ipf.InstrumentProfileType.T_CURRENCY = "CURRENCY"
private

◆ T_ETF

const string com.dxfeed.ipf.InstrumentProfileType.T_ETF = "ETF"
private

◆ T_FOREX

const string com.dxfeed.ipf.InstrumentProfileType.T_FOREX = "FOREX"
private

◆ T_FUTURE

const string com.dxfeed.ipf.InstrumentProfileType.T_FUTURE = "FUTURE"
private

◆ T_INDEX

const string com.dxfeed.ipf.InstrumentProfileType.T_INDEX = "INDEX"
private

◆ T_MONEY_MARKET_FUND

const string com.dxfeed.ipf.InstrumentProfileType.T_MONEY_MARKET_FUND = "MONEY_MARKET_FUND"
private

◆ T_MUTUAL_FUND

const string com.dxfeed.ipf.InstrumentProfileType.T_MUTUAL_FUND = "MUTUAL_FUND"
private

◆ T_OPTION

const string com.dxfeed.ipf.InstrumentProfileType.T_OPTION = "OPTION"
private

◆ T_OTHER

const string com.dxfeed.ipf.InstrumentProfileType.T_OTHER = "OTHER"
private

◆ T_PRODUCT

const string com.dxfeed.ipf.InstrumentProfileType.T_PRODUCT = "PRODUCT"
private

◆ T_REMOVED

const string com.dxfeed.ipf.InstrumentProfileType.T_REMOVED = "REMOVED"
private

◆ T_SPREAD

const string com.dxfeed.ipf.InstrumentProfileType.T_SPREAD = "SPREAD"
private

◆ T_STOCK

const string com.dxfeed.ipf.InstrumentProfileType.T_STOCK = "STOCK"
private

◆ typesMap

Dictionary<string, InstrumentProfileType> com.dxfeed.ipf.InstrumentProfileType.typesMap = new Dictionary<string, InstrumentProfileType>()
staticprivate

Property Documentation

◆ Name

string com.dxfeed.ipf.InstrumentProfileType.Name
getprivate set

Get the name of instrument profile type.


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