Instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument i.e. Optionality:American, Other:InflationLinked - supported addresses (if model provided) i.e. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) i.e. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS More...

Inheritance diagram for Lusid.Sdk.Model.InstrumentCapabilities:

[legend]

Public Member Functions
	InstrumentCapabilities (string instrumentId=default(string), string model=default(string), Dictionary< string, string > features=default(Dictionary< string, string >), List< DescribedAddressKey > supportedAddresses=default(List< DescribedAddressKey >), List< EconomicDependency > economicDependencies=default(List< EconomicDependency >), List< Link > links=default(List< Link >))
	Initializes a new instance of the InstrumentCapabilities 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 (InstrumentCapabilities input)
	Returns true if InstrumentCapabilities instances are equal More...

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

Properties
string	InstrumentId `[get, set]`
	The Lusid instrument id for the instrument e.g. 'LUID_00003D4X'. More...

string	Model `[get, set]`
	The pricing model e.g. 'Discounting'. More...

Dictionary< string, string >	Features `[get, set]`
	Features of the instrument describing its optionality, payoff type and more e.g. 'Instrument/Features/Exercise: American', 'Instrument/Features/Product: Option' More...

List< DescribedAddressKey >	SupportedAddresses `[get, set]`
	Queryable addresses supported by the model, e.g. 'Valuation/Pv', 'Valuation/Accrued'. More...

List< EconomicDependency >	EconomicDependencies `[get, set]`
	Economic dependencies for the model, e.g. 'Fx:GBP.USD', 'Cash:GBP', 'Rates:GBP.GBPOIS'. More...

List< Link >	Links `[get, set]`
	Gets or Sets Links More...

Detailed Description

Instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument i.e. Optionality:American, Other:InflationLinked - supported addresses (if model provided) i.e. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) i.e. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS

Constructor & Destructor Documentation

◆ InstrumentCapabilities()

Lusid.Sdk.Model.InstrumentCapabilities.InstrumentCapabilities	(	string	instrumentId = `default(string)`,
		string	model = `default(string)`,
		Dictionary< string, string >	features = `default(Dictionary<string, string>)`,
		List< DescribedAddressKey >	supportedAddresses = `default(List<DescribedAddressKey>)`,
		List< EconomicDependency >	economicDependencies = `default(List<EconomicDependency>)`,
		List< Link >	links = `default(List<Link>)`
	)

inline

Initializes a new instance of the InstrumentCapabilities class.

Parameters

instrumentId	The Lusid instrument id for the instrument e.g. 'LUID_00003D4X'..
model	The pricing model e.g. 'Discounting'..
features	Features of the instrument describing its optionality, payoff type and more e.g. 'Instrument/Features/Exercise: American', 'Instrument/Features/Product: Option'.
supportedAddresses	Queryable addresses supported by the model, e.g. 'Valuation/Pv', 'Valuation/Accrued'..
economicDependencies	Economic dependencies for the model, e.g. 'Fx:GBP.USD', 'Cash:GBP', 'Rates:GBP.GBPOIS'..
links	links.

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if InstrumentCapabilities instances are equal

Parameters

input Instance of InstrumentCapabilities to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ EconomicDependencies

List<EconomicDependency> Lusid.Sdk.Model.InstrumentCapabilities.EconomicDependencies

getset

Economic dependencies for the model, e.g. 'Fx:GBP.USD', 'Cash:GBP', 'Rates:GBP.GBPOIS'.

◆ Features

Dictionary<string, string> Lusid.Sdk.Model.InstrumentCapabilities.Features

getset

Features of the instrument describing its optionality, payoff type and more e.g. 'Instrument/Features/Exercise: American', 'Instrument/Features/Product: Option'

◆ InstrumentId

string Lusid.Sdk.Model.InstrumentCapabilities.InstrumentId

getset

The Lusid instrument id for the instrument e.g. 'LUID_00003D4X'.

◆ Links

List<Link> Lusid.Sdk.Model.InstrumentCapabilities.Links

getset

Gets or Sets Links

◆ Model

string Lusid.Sdk.Model.InstrumentCapabilities.Model

getset

The pricing model e.g. 'Discounting'.

◆ SupportedAddresses

List<DescribedAddressKey> Lusid.Sdk.Model.InstrumentCapabilities.SupportedAddresses

getset

Queryable addresses supported by the model, e.g. 'Valuation/Pv', 'Valuation/Accrued'.

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/InstrumentCapabilities.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ InstrumentCapabilities()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ EconomicDependencies

◆ Features

◆ InstrumentId

◆ Links

◆ Model

◆ SupportedAddresses