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

The Configuration or Calculation Recipe controls how LUSID processes a given request. This can be used to change where market data used in pricing is loaded from and in what order, or which model is used to price a given instrument as well as how aggregation will process the produced results. More...

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

Public Member Functions

 ConfigurationRecipe (string scope=default(string), string code=default(string), MarketContext market=default(MarketContext), PricingContext pricing=default(PricingContext), AggregationContext aggregation=default(AggregationContext), List< ResourceId > inheritedRecipes=default(List< ResourceId >), string description=default(string), HoldingContext holding=default(HoldingContext))
 Initializes a new instance of the ConfigurationRecipe 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 (ConfigurationRecipe input)
 Returns true if ConfigurationRecipe instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string Scope [get, set]
 The scope used when updating or inserting the Configuration Recipe. More...
 
string Code [get, set]
 User given string name (code) to identify the recipe. More...
 
MarketContext Market [get, set]
 Gets or Sets Market More...
 
PricingContext Pricing [get, set]
 Gets or Sets Pricing More...
 
AggregationContext Aggregation [get, set]
 Gets or Sets Aggregation More...
 
List< ResourceIdInheritedRecipes [get, set]
 A list of parent recipes (scope,code) that can be used to share functionality between recipes. For instance one might use common recipes to set up pricing for individual asset classes, e.g. rates or credit, and then combine them into a single recipe to be used by an exotics desk in conjunction with some overrides that it requires for models or other pricing options. More...
 
string Description [get, set]
 User can assign a description to understand more humanly the recipe. More...
 
HoldingContext Holding [get, set]
 Gets or Sets Holding More...
 

Detailed Description

The Configuration or Calculation Recipe controls how LUSID processes a given request. This can be used to change where market data used in pricing is loaded from and in what order, or which model is used to price a given instrument as well as how aggregation will process the produced results.

Constructor & Destructor Documentation

◆ ConfigurationRecipe() [1/2]

Lusid.Sdk.Model.ConfigurationRecipe.ConfigurationRecipe ( )
inlineprotected

Initializes a new instance of the ConfigurationRecipe class.

◆ ConfigurationRecipe() [2/2]

Lusid.Sdk.Model.ConfigurationRecipe.ConfigurationRecipe ( string  scope = default(string),
string  code = default(string),
MarketContext  market = default(MarketContext),
PricingContext  pricing = default(PricingContext),
AggregationContext  aggregation = default(AggregationContext),
List< ResourceId inheritedRecipes = default(List<ResourceId>),
string  description = default(string),
HoldingContext  holding = default(HoldingContext) 
)
inline

Initializes a new instance of the ConfigurationRecipe class.

Parameters
scopeThe scope used when updating or inserting the Configuration Recipe. (required).
codeUser given string name (code) to identify the recipe. (required).
marketmarket.
pricingpricing.
aggregationaggregation.
inheritedRecipesA list of parent recipes (scope,code) that can be used to share functionality between recipes. For instance one might use common recipes to set up pricing for individual asset classes, e.g. rates or credit, and then combine them into a single recipe to be used by an exotics desk in conjunction with some overrides that it requires for models or other pricing options..
descriptionUser can assign a description to understand more humanly the recipe..
holdingholding.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if ConfigurationRecipe instances are equal

Parameters
inputInstance of ConfigurationRecipe to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Aggregation

AggregationContext Lusid.Sdk.Model.ConfigurationRecipe.Aggregation
getset

Gets or Sets Aggregation

◆ Code

string Lusid.Sdk.Model.ConfigurationRecipe.Code
getset

User given string name (code) to identify the recipe.

User given string name (code) to identify the recipe.

◆ Description

string Lusid.Sdk.Model.ConfigurationRecipe.Description
getset

User can assign a description to understand more humanly the recipe.

User can assign a description to understand more humanly the recipe.

◆ Holding

HoldingContext Lusid.Sdk.Model.ConfigurationRecipe.Holding
getset

Gets or Sets Holding

◆ InheritedRecipes

List<ResourceId> Lusid.Sdk.Model.ConfigurationRecipe.InheritedRecipes
getset

A list of parent recipes (scope,code) that can be used to share functionality between recipes. For instance one might use common recipes to set up pricing for individual asset classes, e.g. rates or credit, and then combine them into a single recipe to be used by an exotics desk in conjunction with some overrides that it requires for models or other pricing options.

A list of parent recipes (scope,code) that can be used to share functionality between recipes. For instance one might use common recipes to set up pricing for individual asset classes, e.g. rates or credit, and then combine them into a single recipe to be used by an exotics desk in conjunction with some overrides that it requires for models or other pricing options.

◆ Market

MarketContext Lusid.Sdk.Model.ConfigurationRecipe.Market
getset

Gets or Sets Market

◆ Pricing

PricingContext Lusid.Sdk.Model.ConfigurationRecipe.Pricing
getset

Gets or Sets Pricing

◆ Scope

string Lusid.Sdk.Model.ConfigurationRecipe.Scope
getset

The scope used when updating or inserting the Configuration Recipe.

The scope used when updating or inserting the Configuration Recipe.


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