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

Market context node. This defines how LUSID processes parts of a request that require resolution of market data such as instrument prices or Fx rates. It controls where the data is loaded from and which sources take precedence. More...

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

Public Member Functions

 MarketContext (List< MarketDataKeyRule > marketRules=default(List< MarketDataKeyRule >), MarketContextSuppliers suppliers=default(MarketContextSuppliers), MarketOptions options=default(MarketOptions), List< MarketDataSpecificRule > specificRules=default(List< MarketDataSpecificRule >), List< GroupOfMarketDataKeyRules > groupedMarketRules=default(List< GroupOfMarketDataKeyRules >))
 Initializes a new instance of the MarketContext 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 (MarketContext input)
 Returns true if MarketContext instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Properties

List< MarketDataKeyRuleMarketRules [get, set]
 The set of rules that define how to resolve particular use cases. These can be relatively general or specific in nature. Nominally any number are possible and will be processed in order where applicable. However, there is evidently a potential for increased computational cost where many rules must be applied to resolve data. Ensuring that portfolios are structured in such a way as to reduce the number of rules required is therefore sensible. More...
 
MarketContextSuppliers Suppliers [get, set]
 Gets or Sets Suppliers More...
 
MarketOptions Options [get, set]
 Gets or Sets Options More...
 
List< MarketDataSpecificRuleSpecificRules [get, set]
 Extends market data key rules to be able to catch dependencies depending on where the dependency comes from, as opposed to what the dependency is asking for. Using two specific rules, one could instruct rates curves requested by bonds to be retrieved from a different scope than rates curves requested by swaps. WARNING: The use of specific rules impacts performance. Where possible, one should use MarketDataKeyRules only. More...
 
List< GroupOfMarketDataKeyRulesGroupedMarketRules [get, set]
 The list of groups of rules that will be used in market data resolution. Rules given within a group will, if the group is being used to resolve data, all be applied with the results of those individual resolution attempts combined into a single result. The method for combining results is determined by the operation detailed in the GroupOfMarketDataKeyRules. Notes: - When resolving MarketData, MarketRules will be applied first followed by GroupedMarketRules if data could not be found using only the MarketRules provided. - GroupedMarketRules can only be used for resolving data from the QuoteStore. Caution: As every rule in a given group will be applied in resolution if the group is applied, groups are computationally expensive for market data resolution. Therefore, heuristically, rule groups should be kept as small as possible. More...
 

Detailed Description

Market context node. This defines how LUSID processes parts of a request that require resolution of market data such as instrument prices or Fx rates. It controls where the data is loaded from and which sources take precedence.

Constructor & Destructor Documentation

◆ MarketContext()

Lusid.Sdk.Model.MarketContext.MarketContext ( List< MarketDataKeyRule marketRules = default(List<MarketDataKeyRule>),
MarketContextSuppliers  suppliers = default(MarketContextSuppliers),
MarketOptions  options = default(MarketOptions),
List< MarketDataSpecificRule specificRules = default(List<MarketDataSpecificRule>),
List< GroupOfMarketDataKeyRules groupedMarketRules = default(List<GroupOfMarketDataKeyRules>) 
)
inline

Initializes a new instance of the MarketContext class.

Parameters
marketRulesThe set of rules that define how to resolve particular use cases. These can be relatively general or specific in nature. Nominally any number are possible and will be processed in order where applicable. However, there is evidently a potential for increased computational cost where many rules must be applied to resolve data. Ensuring that portfolios are structured in such a way as to reduce the number of rules required is therefore sensible..
supplierssuppliers.
optionsoptions.
specificRulesExtends market data key rules to be able to catch dependencies depending on where the dependency comes from, as opposed to what the dependency is asking for. Using two specific rules, one could instruct rates curves requested by bonds to be retrieved from a different scope than rates curves requested by swaps. WARNING: The use of specific rules impacts performance. Where possible, one should use MarketDataKeyRules only..
groupedMarketRulesThe list of groups of rules that will be used in market data resolution. Rules given within a group will, if the group is being used to resolve data, all be applied with the results of those individual resolution attempts combined into a single result. The method for combining results is determined by the operation detailed in the GroupOfMarketDataKeyRules. Notes: - When resolving MarketData, MarketRules will be applied first followed by GroupedMarketRules if data could not be found using only the MarketRules provided. - GroupedMarketRules can only be used for resolving data from the QuoteStore. Caution: As every rule in a given group will be applied in resolution if the group is applied, groups are computationally expensive for market data resolution. Therefore, heuristically, rule groups should be kept as small as possible..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if MarketContext instances are equal

Parameters
inputInstance of MarketContext to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ GroupedMarketRules

List<GroupOfMarketDataKeyRules> Lusid.Sdk.Model.MarketContext.GroupedMarketRules
getset

The list of groups of rules that will be used in market data resolution. Rules given within a group will, if the group is being used to resolve data, all be applied with the results of those individual resolution attempts combined into a single result. The method for combining results is determined by the operation detailed in the GroupOfMarketDataKeyRules. Notes: - When resolving MarketData, MarketRules will be applied first followed by GroupedMarketRules if data could not be found using only the MarketRules provided. - GroupedMarketRules can only be used for resolving data from the QuoteStore. Caution: As every rule in a given group will be applied in resolution if the group is applied, groups are computationally expensive for market data resolution. Therefore, heuristically, rule groups should be kept as small as possible.

The list of groups of rules that will be used in market data resolution. Rules given within a group will, if the group is being used to resolve data, all be applied with the results of those individual resolution attempts combined into a single result. The method for combining results is determined by the operation detailed in the GroupOfMarketDataKeyRules. Notes: - When resolving MarketData, MarketRules will be applied first followed by GroupedMarketRules if data could not be found using only the MarketRules provided. - GroupedMarketRules can only be used for resolving data from the QuoteStore. Caution: As every rule in a given group will be applied in resolution if the group is applied, groups are computationally expensive for market data resolution. Therefore, heuristically, rule groups should be kept as small as possible.

◆ MarketRules

List<MarketDataKeyRule> Lusid.Sdk.Model.MarketContext.MarketRules
getset

The set of rules that define how to resolve particular use cases. These can be relatively general or specific in nature. Nominally any number are possible and will be processed in order where applicable. However, there is evidently a potential for increased computational cost where many rules must be applied to resolve data. Ensuring that portfolios are structured in such a way as to reduce the number of rules required is therefore sensible.

The set of rules that define how to resolve particular use cases. These can be relatively general or specific in nature. Nominally any number are possible and will be processed in order where applicable. However, there is evidently a potential for increased computational cost where many rules must be applied to resolve data. Ensuring that portfolios are structured in such a way as to reduce the number of rules required is therefore sensible.

◆ Options

MarketOptions Lusid.Sdk.Model.MarketContext.Options
getset

Gets or Sets Options

◆ SpecificRules

List<MarketDataSpecificRule> Lusid.Sdk.Model.MarketContext.SpecificRules
getset

Extends market data key rules to be able to catch dependencies depending on where the dependency comes from, as opposed to what the dependency is asking for. Using two specific rules, one could instruct rates curves requested by bonds to be retrieved from a different scope than rates curves requested by swaps. WARNING: The use of specific rules impacts performance. Where possible, one should use MarketDataKeyRules only.

Extends market data key rules to be able to catch dependencies depending on where the dependency comes from, as opposed to what the dependency is asking for. Using two specific rules, one could instruct rates curves requested by bonds to be retrieved from a different scope than rates curves requested by swaps. WARNING: The use of specific rules impacts performance. Where possible, one should use MarketDataKeyRules only.

◆ Suppliers

MarketContextSuppliers Lusid.Sdk.Model.MarketContext.Suppliers
getset

Gets or Sets Suppliers


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