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

The set of options that control miscellaneous and default market resolution behaviour. These are aimed at a 'crude' level of control for those who do not wish to fine tune the way that data is resolved. For clients who wish to simply match instruments to prices this is quite possibly sufficient. For those wishing to control market data sources according to requirements based on accuracy or timeliness it is not. In more advanced cases the options should largely be ignored and rules specified per source. Be aware that where no specified rule matches the final fallback is on to the logic implied here. More...

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

Public Member Functions

 MarketOptions (string defaultSupplier=default(string), string defaultInstrumentCodeType=default(string), string defaultScope=default(string), bool attemptToInferMissingFx=default(bool), string calendarScope=default(string), string conventionScope=default(string))
 Initializes a new instance of the MarketOptions 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 (MarketOptions input)
 Returns true if MarketOptions instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string DefaultSupplier [get, set]
 The default supplier of data. This controls which 'dialect' is used to find particular market data. e.g. one supplier might address data by RIC, another by PermId More...
 
string DefaultInstrumentCodeType [get, set]
 When instrument quotes are searched for, what identifier should be used by default More...
 
string DefaultScope [get, set]
 For default rules, which scope should data be searched for in More...
 
bool AttemptToInferMissingFx [get, set]
 if true will calculate a missing Fx pair (e.g. THBJPY) from the inverse JPYTHB or from standardised pairs against USD, e.g. THBUSD and JPYUSD More...
 
string CalendarScope [get, set]
 The scope in which holiday calendars stored More...
 
string ConventionScope [get, set]
 The scope in which conventions stored More...
 

Detailed Description

The set of options that control miscellaneous and default market resolution behaviour. These are aimed at a 'crude' level of control for those who do not wish to fine tune the way that data is resolved. For clients who wish to simply match instruments to prices this is quite possibly sufficient. For those wishing to control market data sources according to requirements based on accuracy or timeliness it is not. In more advanced cases the options should largely be ignored and rules specified per source. Be aware that where no specified rule matches the final fallback is on to the logic implied here.

Constructor & Destructor Documentation

◆ MarketOptions() [1/2]

Lusid.Sdk.Model.MarketOptions.MarketOptions ( )
inlineprotected

Initializes a new instance of the MarketOptions class.

◆ MarketOptions() [2/2]

Lusid.Sdk.Model.MarketOptions.MarketOptions ( string  defaultSupplier = default(string),
string  defaultInstrumentCodeType = default(string),
string  defaultScope = default(string),
bool  attemptToInferMissingFx = default(bool),
string  calendarScope = default(string),
string  conventionScope = default(string) 
)
inline

Initializes a new instance of the MarketOptions class.

Parameters
defaultSupplierThe default supplier of data. This controls which 'dialect' is used to find particular market data. e.g. one supplier might address data by RIC, another by PermId.
defaultInstrumentCodeTypeWhen instrument quotes are searched for, what identifier should be used by default.
defaultScopeFor default rules, which scope should data be searched for in (required).
attemptToInferMissingFxif true will calculate a missing Fx pair (e.g. THBJPY) from the inverse JPYTHB or from standardised pairs against USD, e.g. THBUSD and JPYUSD.
calendarScopeThe scope in which holiday calendars stored.
conventionScopeThe scope in which conventions stored.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if MarketOptions instances are equal

Parameters
inputInstance of MarketOptions to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AttemptToInferMissingFx

bool Lusid.Sdk.Model.MarketOptions.AttemptToInferMissingFx
getset

if true will calculate a missing Fx pair (e.g. THBJPY) from the inverse JPYTHB or from standardised pairs against USD, e.g. THBUSD and JPYUSD

if true will calculate a missing Fx pair (e.g. THBJPY) from the inverse JPYTHB or from standardised pairs against USD, e.g. THBUSD and JPYUSD

◆ CalendarScope

string Lusid.Sdk.Model.MarketOptions.CalendarScope
getset

The scope in which holiday calendars stored

The scope in which holiday calendars stored

◆ ConventionScope

string Lusid.Sdk.Model.MarketOptions.ConventionScope
getset

The scope in which conventions stored

The scope in which conventions stored

◆ DefaultInstrumentCodeType

string Lusid.Sdk.Model.MarketOptions.DefaultInstrumentCodeType
getset

When instrument quotes are searched for, what identifier should be used by default

When instrument quotes are searched for, what identifier should be used by default

◆ DefaultScope

string Lusid.Sdk.Model.MarketOptions.DefaultScope
getset

For default rules, which scope should data be searched for in

For default rules, which scope should data be searched for in

◆ DefaultSupplier

string Lusid.Sdk.Model.MarketOptions.DefaultSupplier
getset

The default supplier of data. This controls which 'dialect' is used to find particular market data. e.g. one supplier might address data by RIC, another by PermId

The default supplier of data. This controls which 'dialect' is used to find particular market data. e.g. one supplier might address data by RIC, another by PermId


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