A rule that identifies the set of preferences to be used for a given library, model and instrument type. There can be many such rules, though only the first found for a given combination would be used. More...

Inheritance diagram for Lusid.Sdk.Model.VendorModelRule:

[legend]

Public Types
enum class	SupplierEnum { Lusid = 1 , RefinitivQps = 2 , RefinitivTracsWeb = 3 , VolMaster = 4 , IsdaCds = 5 , YieldBook = 6 , LusidCalc = 7 }
	The available values are: Lusid, RefinitivQps, RefinitivTracsWeb, VolMaster, IsdaCds, YieldBook, LusidCalc More...

Public Member Functions
	VendorModelRule (SupplierEnum supplier=default(SupplierEnum), string modelName=default(string), string instrumentType=default(string), string parameters=default(string), ModelOptions modelOptions=default(ModelOptions), string instrumentId=default(string), List< AddressKeyFilter > addressKeyFilters=default(List< AddressKeyFilter >))
	Initializes a new instance of the VendorModelRule 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 (VendorModelRule input)
	Returns true if VendorModelRule instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	VendorModelRule ()
	Initializes a new instance of the VendorModelRule class. More...

Properties
SupplierEnum	Supplier `[get, set]`
	The available values are: Lusid, RefinitivQps, RefinitivTracsWeb, VolMaster, IsdaCds, YieldBook, LusidCalc More...

string	ModelName `[get, set]`
	The vendor library model name More...

string	InstrumentType `[get, set]`
	The vendor library instrument type More...

string	Parameters `[get, set]`
	THIS FIELD IS DEPRECATED - use ModelOptions The set of opaque model parameters, provided as a Json object, that is a string object which will internally be converted to a dictionary of string to object. Note that this is not intended as the final form of this object. It will be replaced with a more structured object as the set of parameters that are possible is better understood. More...

ModelOptions	ModelOptions `[get, set]`
	Gets or Sets ModelOptions More...

string	InstrumentId `[get, set]`
	This field should generally not be required. It indicates a specific case where there is a particular need to make a rule apply to only a single instrument specified by an identifier on that instrument such as its LUID. One particular example would be to control the behaviour of a look-through portfolio scaling methodology, such as where there is a mixture of indices and credit-debit portfolios where scaling on the sum of valuation would be deemed incorrectly for one set but desired in general. More...

List< AddressKeyFilter >	AddressKeyFilters `[get, set]`
	Condition for model selection. If a condition is satisfied the default model for valuation is overridden (for that instrument). More...

Detailed Description

A rule that identifies the set of preferences to be used for a given library, model and instrument type. There can be many such rules, though only the first found for a given combination would be used.

Member Enumeration Documentation

◆ SupplierEnum

enum Lusid.Sdk.Model.VendorModelRule.SupplierEnum

strong

The available values are: Lusid, RefinitivQps, RefinitivTracsWeb, VolMaster, IsdaCds, YieldBook, LusidCalc

Enumerator
Lusid	Enum Lusid for value: Lusid
RefinitivQps	Enum RefinitivQps for value: RefinitivQps
RefinitivTracsWeb	Enum RefinitivTracsWeb for value: RefinitivTracsWeb
VolMaster	Enum VolMaster for value: VolMaster
IsdaCds	Enum IsdaCds for value: IsdaCds
YieldBook	Enum YieldBook for value: YieldBook
LusidCalc	Enum LusidCalc for value: LusidCalc

Constructor & Destructor Documentation

◆ VendorModelRule() [1/2]

Lusid.Sdk.Model.VendorModelRule.VendorModelRule ( )

inlineprotected

Initializes a new instance of the VendorModelRule class.

◆ VendorModelRule() [2/2]

Lusid.Sdk.Model.VendorModelRule.VendorModelRule	(	SupplierEnum	supplier = `default(SupplierEnum)`,
		string	modelName = `default(string)`,
		string	instrumentType = `default(string)`,
		string	parameters = `default(string)`,
		ModelOptions	modelOptions = `default(ModelOptions)`,
		string	instrumentId = `default(string)`,
		List< AddressKeyFilter >	addressKeyFilters = `default(List<AddressKeyFilter>)`
	)

inline

Initializes a new instance of the VendorModelRule class.

Parameters

supplier	The available values are: Lusid, RefinitivQps, RefinitivTracsWeb, VolMaster, IsdaCds, YieldBook, LusidCalc (required).
modelName	The vendor library model name (required).
instrumentType	The vendor library instrument type (required).
parameters	THIS FIELD IS DEPRECATED - use ModelOptions The set of opaque model parameters, provided as a Json object, that is a string object which will internally be converted to a dictionary of string to object. Note that this is not intended as the final form of this object. It will be replaced with a more structured object as the set of parameters that are possible is better understood..
modelOptions	modelOptions.
instrumentId	This field should generally not be required. It indicates a specific case where there is a particular need to make a rule apply to only a single instrument specified by an identifier on that instrument such as its LUID. One particular example would be to control the behaviour of a look-through portfolio scaling methodology, such as where there is a mixture of indices and credit-debit portfolios where scaling on the sum of valuation would be deemed incorrectly for one set but desired in general..
addressKeyFilters	Condition for model selection. If a condition is satisfied the default model for valuation is overridden (for that instrument)..

Member Function Documentation

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.VendorModelRule.Equals ( object input )

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool Lusid.Sdk.Model.VendorModelRule.Equals ( VendorModelRule input )

inline

Returns true if VendorModelRule instances are equal

Parameters

input Instance of VendorModelRule to be compared

Returns: Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.VendorModelRule.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.VendorModelRule.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.VendorModelRule.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AddressKeyFilters

List<AddressKeyFilter> Lusid.Sdk.Model.VendorModelRule.AddressKeyFilters

getset

Condition for model selection. If a condition is satisfied the default model for valuation is overridden (for that instrument).

◆ InstrumentId

string Lusid.Sdk.Model.VendorModelRule.InstrumentId

getset

This field should generally not be required. It indicates a specific case where there is a particular need to make a rule apply to only a single instrument specified by an identifier on that instrument such as its LUID. One particular example would be to control the behaviour of a look-through portfolio scaling methodology, such as where there is a mixture of indices and credit-debit portfolios where scaling on the sum of valuation would be deemed incorrectly for one set but desired in general.

◆ InstrumentType

string Lusid.Sdk.Model.VendorModelRule.InstrumentType

getset

The vendor library instrument type

◆ ModelName

string Lusid.Sdk.Model.VendorModelRule.ModelName

getset

The vendor library model name

◆ ModelOptions

ModelOptions Lusid.Sdk.Model.VendorModelRule.ModelOptions

getset

Gets or Sets ModelOptions

◆ Parameters

string Lusid.Sdk.Model.VendorModelRule.Parameters

getset

THIS FIELD IS DEPRECATED - use ModelOptions The set of opaque model parameters, provided as a Json object, that is a string object which will internally be converted to a dictionary of string to object. Note that this is not intended as the final form of this object. It will be replaced with a more structured object as the set of parameters that are possible is better understood.

◆ Supplier

SupplierEnum Lusid.Sdk.Model.VendorModelRule.Supplier

getset

The available values are: Lusid, RefinitivQps, RefinitivTracsWeb, VolMaster, IsdaCds, YieldBook, LusidCalc

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/VendorModelRule.cs

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ SupplierEnum

Constructor & Destructor Documentation

◆ VendorModelRule() [1/2]

◆ VendorModelRule() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AddressKeyFilters

◆ InstrumentId

◆ InstrumentType

◆ ModelName

◆ ModelOptions

◆ Parameters

◆ Supplier