LUSID C# SDK
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.QuoteSeriesId Class Reference

The time invariant unique identifier of the quote. Combined with the effective datetime of the quote this uniquely identifies the quote. This can be thought of as a unique identifier for a time series of quotes. More...

Inheritance diagram for Lusid.Sdk.Model.QuoteSeriesId:
Inheritance graph
[legend]

Public Types

enum class  InstrumentIdTypeEnum {
  LusidInstrumentId = 1 , Figi = 2 , RIC = 3 , QuotePermId = 4 ,
  Isin = 5 , CurrencyPair = 6 , ClientInternal = 7 , Sedol = 8 ,
  Cusip = 9
}
 The type of instrument identifier used to uniquely identify the instrument that the quote is for, e.g. 'Figi'. The available values are: LusidInstrumentId, Figi, RIC, QuotePermId, Isin, CurrencyPair, ClientInternal, Sedol, Cusip More...
 
enum class  QuoteTypeEnum {
  Price = 1 , Spread = 2 , Rate = 3 , LogNormalVol = 4 ,
  NormalVol = 5 , ParSpread = 6 , IsdaSpread = 7 , Upfront = 8 ,
  Index = 9 , Ratio = 10 , Delta = 11 , PoolFactor = 12 ,
  InflationAssumption = 13 , DirtyPrice = 14
}
 The type of the quote. This allows for quotes other than prices e.g. rates or spreads to be used. The available values are: Price, Spread, Rate, LogNormalVol, NormalVol, ParSpread, IsdaSpread, Upfront, Index, Ratio, Delta, PoolFactor, InflationAssumption, DirtyPrice More...
 

Public Member Functions

 QuoteSeriesId (string provider=default(string), string priceSource=default(string), string instrumentId=default(string), InstrumentIdTypeEnum instrumentIdType=default(InstrumentIdTypeEnum), QuoteTypeEnum quoteType=default(QuoteTypeEnum), string field=default(string))
 Initializes a new instance of the QuoteSeriesId class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
virtual string ToJson ()
 Returns the JSON string presentation of the object More...
 
override bool Equals (object input)
 Returns true if objects are equal More...
 
bool Equals (QuoteSeriesId input)
 Returns true if QuoteSeriesId instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 QuoteSeriesId ()
 Initializes a new instance of the QuoteSeriesId class. More...
 

Properties

InstrumentIdTypeEnum InstrumentIdType [get, set]
 The type of instrument identifier used to uniquely identify the instrument that the quote is for, e.g. 'Figi'. The available values are: LusidInstrumentId, Figi, RIC, QuotePermId, Isin, CurrencyPair, ClientInternal, Sedol, Cusip More...
 
QuoteTypeEnum QuoteType [get, set]
 The type of the quote. This allows for quotes other than prices e.g. rates or spreads to be used. The available values are: Price, Spread, Rate, LogNormalVol, NormalVol, ParSpread, IsdaSpread, Upfront, Index, Ratio, Delta, PoolFactor, InflationAssumption, DirtyPrice More...
 
string Provider [get, set]
 The platform or vendor that provided the quote. The available values are: Client, DataScope, Lusid, Edi, TraderMade, FactSet, SIX, Bloomberg, Rimes More...
 
string PriceSource [get, set]
 The source or originator of the quote, e.g. a bank or financial institution. More...
 
string InstrumentId [get, set]
 The value of the instrument identifier that uniquely identifies the instrument that the quote is for, e.g. 'BBG00JX0P539'. More...
 
string Field [get, set]
 The field of the quote e.g. bid, mid, ask etc. This should be consistent across a time series of quotes. The allowed values depend on the provider according to the following rules: Client : Any value is accepted; DataScope : 'bid', 'mid', 'ask'; Lusid : Any value is accepted; Edi : 'bid', 'mid', 'ask', 'open', 'close', 'last'; TraderMade : 'bid', 'mid', 'ask', 'open', 'close', 'high', 'low'; FactSet : 'bid', 'mid', 'ask', 'open', 'close'; SIX : 'bid', 'mid', 'ask', 'open', 'close', 'last'; Bloomberg : 'bid', 'mid', 'ask', 'open', 'close', 'last'; Rimes : 'bid', 'mid', 'ask', 'open', 'close', 'last' More...
 

Detailed Description

The time invariant unique identifier of the quote. Combined with the effective datetime of the quote this uniquely identifies the quote. This can be thought of as a unique identifier for a time series of quotes.

Member Enumeration Documentation

◆ InstrumentIdTypeEnum

The type of instrument identifier used to uniquely identify the instrument that the quote is for, e.g. 'Figi'. The available values are: LusidInstrumentId, Figi, RIC, QuotePermId, Isin, CurrencyPair, ClientInternal, Sedol, Cusip

The type of instrument identifier used to uniquely identify the instrument that the quote is for, e.g. 'Figi'. The available values are: LusidInstrumentId, Figi, RIC, QuotePermId, Isin, CurrencyPair, ClientInternal, Sedol, Cusip

Enumerator
LusidInstrumentId 

Enum LusidInstrumentId for value: LusidInstrumentId

Figi 

Enum Figi for value: Figi

RIC 

Enum RIC for value: RIC

QuotePermId 

Enum QuotePermId for value: QuotePermId

Isin 

Enum Isin for value: Isin

CurrencyPair 

Enum CurrencyPair for value: CurrencyPair

ClientInternal 

Enum ClientInternal for value: ClientInternal

Sedol 

Enum Sedol for value: Sedol

Cusip 

Enum Cusip for value: Cusip

◆ QuoteTypeEnum

The type of the quote. This allows for quotes other than prices e.g. rates or spreads to be used. The available values are: Price, Spread, Rate, LogNormalVol, NormalVol, ParSpread, IsdaSpread, Upfront, Index, Ratio, Delta, PoolFactor, InflationAssumption, DirtyPrice

The type of the quote. This allows for quotes other than prices e.g. rates or spreads to be used. The available values are: Price, Spread, Rate, LogNormalVol, NormalVol, ParSpread, IsdaSpread, Upfront, Index, Ratio, Delta, PoolFactor, InflationAssumption, DirtyPrice

Enumerator
Price 

Enum Price for value: Price

Spread 

Enum Spread for value: Spread

Rate 

Enum Rate for value: Rate

LogNormalVol 

Enum LogNormalVol for value: LogNormalVol

NormalVol 

Enum NormalVol for value: NormalVol

ParSpread 

Enum ParSpread for value: ParSpread

IsdaSpread 

Enum IsdaSpread for value: IsdaSpread

Upfront 

Enum Upfront for value: Upfront

Index 

Enum Index for value: Index

Ratio 

Enum Ratio for value: Ratio

Delta 

Enum Delta for value: Delta

PoolFactor 

Enum PoolFactor for value: PoolFactor

InflationAssumption 

Enum InflationAssumption for value: InflationAssumption

DirtyPrice 

Enum DirtyPrice for value: DirtyPrice

Constructor & Destructor Documentation

◆ QuoteSeriesId() [1/2]

Lusid.Sdk.Model.QuoteSeriesId.QuoteSeriesId ( )
inlineprotected

Initializes a new instance of the QuoteSeriesId class.

◆ QuoteSeriesId() [2/2]

Lusid.Sdk.Model.QuoteSeriesId.QuoteSeriesId ( string  provider = default(string),
string  priceSource = default(string),
string  instrumentId = default(string),
InstrumentIdTypeEnum  instrumentIdType = default(InstrumentIdTypeEnum),
QuoteTypeEnum  quoteType = default(QuoteTypeEnum),
string  field = default(string) 
)
inline

Initializes a new instance of the QuoteSeriesId class.

Parameters
providerThe platform or vendor that provided the quote. The available values are: Client, DataScope, Lusid, Edi, TraderMade, FactSet, SIX, Bloomberg, Rimes (required).
priceSourceThe source or originator of the quote, e.g. a bank or financial institution..
instrumentIdThe value of the instrument identifier that uniquely identifies the instrument that the quote is for, e.g. 'BBG00JX0P539'. (required).
instrumentIdTypeThe type of instrument identifier used to uniquely identify the instrument that the quote is for, e.g. 'Figi'. The available values are: LusidInstrumentId, Figi, RIC, QuotePermId, Isin, CurrencyPair, ClientInternal, Sedol, Cusip (required).
quoteTypeThe type of the quote. This allows for quotes other than prices e.g. rates or spreads to be used. The available values are: Price, Spread, Rate, LogNormalVol, NormalVol, ParSpread, IsdaSpread, Upfront, Index, Ratio, Delta, PoolFactor, InflationAssumption, DirtyPrice (required).
fieldThe field of the quote e.g. bid, mid, ask etc. This should be consistent across a time series of quotes. The allowed values depend on the provider according to the following rules: Client : Any value is accepted; DataScope : 'bid', 'mid', 'ask'; Lusid : Any value is accepted; Edi : 'bid', 'mid', 'ask', 'open', 'close', 'last'; TraderMade : 'bid', 'mid', 'ask', 'open', 'close', 'high', 'low'; FactSet : 'bid', 'mid', 'ask', 'open', 'close'; SIX : 'bid', 'mid', 'ask', 'open', 'close', 'last'; Bloomberg : 'bid', 'mid', 'ask', 'open', 'close', 'last'; Rimes : 'bid', 'mid', 'ask', 'open', 'close', 'last' (required).

Member Function Documentation

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.QuoteSeriesId.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool Lusid.Sdk.Model.QuoteSeriesId.Equals ( QuoteSeriesId  input)
inline

Returns true if QuoteSeriesId instances are equal

Parameters
inputInstance of QuoteSeriesId to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.QuoteSeriesId.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.QuoteSeriesId.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.QuoteSeriesId.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Field

string Lusid.Sdk.Model.QuoteSeriesId.Field
getset

The field of the quote e.g. bid, mid, ask etc. This should be consistent across a time series of quotes. The allowed values depend on the provider according to the following rules: Client : Any value is accepted; DataScope : 'bid', 'mid', 'ask'; Lusid : Any value is accepted; Edi : 'bid', 'mid', 'ask', 'open', 'close', 'last'; TraderMade : 'bid', 'mid', 'ask', 'open', 'close', 'high', 'low'; FactSet : 'bid', 'mid', 'ask', 'open', 'close'; SIX : 'bid', 'mid', 'ask', 'open', 'close', 'last'; Bloomberg : 'bid', 'mid', 'ask', 'open', 'close', 'last'; Rimes : 'bid', 'mid', 'ask', 'open', 'close', 'last'

The field of the quote e.g. bid, mid, ask etc. This should be consistent across a time series of quotes. The allowed values depend on the provider according to the following rules: Client : Any value is accepted; DataScope : 'bid', 'mid', 'ask'; Lusid : Any value is accepted; Edi : 'bid', 'mid', 'ask', 'open', 'close', 'last'; TraderMade : 'bid', 'mid', 'ask', 'open', 'close', 'high', 'low'; FactSet : 'bid', 'mid', 'ask', 'open', 'close'; SIX : 'bid', 'mid', 'ask', 'open', 'close', 'last'; Bloomberg : 'bid', 'mid', 'ask', 'open', 'close', 'last'; Rimes : 'bid', 'mid', 'ask', 'open', 'close', 'last'

◆ InstrumentId

string Lusid.Sdk.Model.QuoteSeriesId.InstrumentId
getset

The value of the instrument identifier that uniquely identifies the instrument that the quote is for, e.g. 'BBG00JX0P539'.

The value of the instrument identifier that uniquely identifies the instrument that the quote is for, e.g. 'BBG00JX0P539'.

◆ InstrumentIdType

InstrumentIdTypeEnum Lusid.Sdk.Model.QuoteSeriesId.InstrumentIdType
getset

The type of instrument identifier used to uniquely identify the instrument that the quote is for, e.g. 'Figi'. The available values are: LusidInstrumentId, Figi, RIC, QuotePermId, Isin, CurrencyPair, ClientInternal, Sedol, Cusip

The type of instrument identifier used to uniquely identify the instrument that the quote is for, e.g. 'Figi'. The available values are: LusidInstrumentId, Figi, RIC, QuotePermId, Isin, CurrencyPair, ClientInternal, Sedol, Cusip

◆ PriceSource

string Lusid.Sdk.Model.QuoteSeriesId.PriceSource
getset

The source or originator of the quote, e.g. a bank or financial institution.

The source or originator of the quote, e.g. a bank or financial institution.

◆ Provider

string Lusid.Sdk.Model.QuoteSeriesId.Provider
getset

The platform or vendor that provided the quote. The available values are: Client, DataScope, Lusid, Edi, TraderMade, FactSet, SIX, Bloomberg, Rimes

The platform or vendor that provided the quote. The available values are: Client, DataScope, Lusid, Edi, TraderMade, FactSet, SIX, Bloomberg, Rimes

◆ QuoteType

QuoteTypeEnum Lusid.Sdk.Model.QuoteSeriesId.QuoteType
getset

The type of the quote. This allows for quotes other than prices e.g. rates or spreads to be used. The available values are: Price, Spread, Rate, LogNormalVol, NormalVol, ParSpread, IsdaSpread, Upfront, Index, Ratio, Delta, PoolFactor, InflationAssumption, DirtyPrice

The type of the quote. This allows for quotes other than prices e.g. rates or spreads to be used. The available values are: Price, Spread, Rate, LogNormalVol, NormalVol, ParSpread, IsdaSpread, Upfront, Index, Ratio, Delta, PoolFactor, InflationAssumption, DirtyPrice


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