Base class in hierarchy for LUSID Instruments. Valuation would normally be performed through passing LUSID a Code for a portfolio to be valued. In that case the set of instruments have already been uploaded. Equally, one might wish to pass in a set of instruments directly and have LUSID value the inlined set. This the base instrument for this case. More...

Inheritance diagram for Lusid.Sdk.Model.LusidInstrument:

[legend]

Public Types
enum	InstrumentTypeEnum { InstrumentTypeEnum.QuotedSecurity = 1, InstrumentTypeEnum.InterestRateSwap = 2, InstrumentTypeEnum.FxForward = 3, InstrumentTypeEnum.Future = 4, InstrumentTypeEnum.ExoticInstrument = 5, InstrumentTypeEnum.FxOption = 6, InstrumentTypeEnum.CreditDefaultSwap = 7, InstrumentTypeEnum.InterestRateSwaption = 8, InstrumentTypeEnum.Bond = 9, InstrumentTypeEnum.EquityOption = 10, InstrumentTypeEnum.FixedLeg = 11, InstrumentTypeEnum.FloatingLeg = 12, InstrumentTypeEnum.BespokeCashFlowsLeg = 13, InstrumentTypeEnum.Unknown = 14, InstrumentTypeEnum.TermDeposit = 15, InstrumentTypeEnum.ContractForDifference = 16, InstrumentTypeEnum.EquitySwap = 17, InstrumentTypeEnum.CashPerpetual = 18, InstrumentTypeEnum.CashSettled = 19, InstrumentTypeEnum.CdsIndex = 20, InstrumentTypeEnum.Basket = 21, InstrumentTypeEnum.FundingLeg = 22, InstrumentTypeEnum.CrossCurrencySwap = 23, InstrumentTypeEnum.FxSwap = 24, InstrumentTypeEnum.ForwardRateAgreement = 25, InstrumentTypeEnum.SimpleInstrument = 26, InstrumentTypeEnum.Repo = 27 }
	The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CashSettled, CdsIndex, Basket, FundingLeg, CrossCurrencySwap, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo More...

Public Member Functions
	LusidInstrument (InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
	Initializes a new instance of the LusidInstrument 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 (LusidInstrument input)
	Returns true if LusidInstrument instances are equal More...

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

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

Properties
InstrumentTypeEnum	InstrumentType `[get, set]`
	The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CashSettled, CdsIndex, Basket, FundingLeg, CrossCurrencySwap, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo More...

Detailed Description

Base class in hierarchy for LUSID Instruments. Valuation would normally be performed through passing LUSID a Code for a portfolio to be valued. In that case the set of instruments have already been uploaded. Equally, one might wish to pass in a set of instruments directly and have LUSID value the inlined set. This the base instrument for this case.

Member Enumeration Documentation

◆ InstrumentTypeEnum

enum Lusid.Sdk.Model.LusidInstrument.InstrumentTypeEnum

strong

The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CashSettled, CdsIndex, Basket, FundingLeg, CrossCurrencySwap, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo

Enumerator
QuotedSecurity	Enum QuotedSecurity for value: QuotedSecurity
InterestRateSwap	Enum InterestRateSwap for value: InterestRateSwap
FxForward	Enum FxForward for value: FxForward
Future	Enum Future for value: Future
ExoticInstrument	Enum ExoticInstrument for value: ExoticInstrument
FxOption	Enum FxOption for value: FxOption
CreditDefaultSwap	Enum CreditDefaultSwap for value: CreditDefaultSwap
InterestRateSwaption	Enum InterestRateSwaption for value: InterestRateSwaption
Bond	Enum Bond for value: Bond
EquityOption	Enum EquityOption for value: EquityOption
FixedLeg	Enum FixedLeg for value: FixedLeg
FloatingLeg	Enum FloatingLeg for value: FloatingLeg
BespokeCashFlowsLeg	Enum BespokeCashFlowsLeg for value: BespokeCashFlowsLeg
Unknown	Enum Unknown for value: Unknown
TermDeposit	Enum TermDeposit for value: TermDeposit
ContractForDifference	Enum ContractForDifference for value: ContractForDifference
EquitySwap	Enum EquitySwap for value: EquitySwap
CashPerpetual	Enum CashPerpetual for value: CashPerpetual
CashSettled	Enum CashSettled for value: CashSettled
CdsIndex	Enum CdsIndex for value: CdsIndex
Basket	Enum Basket for value: Basket
FundingLeg	Enum FundingLeg for value: FundingLeg
CrossCurrencySwap	Enum CrossCurrencySwap for value: CrossCurrencySwap
FxSwap	Enum FxSwap for value: FxSwap
ForwardRateAgreement	Enum ForwardRateAgreement for value: ForwardRateAgreement
SimpleInstrument	Enum SimpleInstrument for value: SimpleInstrument
Repo	Enum Repo for value: Repo

Constructor & Destructor Documentation

◆ LusidInstrument() [1/2]

Lusid.Sdk.Model.LusidInstrument.LusidInstrument ( )

inlineprotected

Initializes a new instance of the LusidInstrument class.

◆ LusidInstrument() [2/2]

Lusid.Sdk.Model.LusidInstrument.LusidInstrument ( InstrumentTypeEnum instrumentType = default(InstrumentTypeEnum) )

inline

Initializes a new instance of the LusidInstrument class.

Parameters

instrumentType The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CashSettled, CdsIndex, Basket, FundingLeg, CrossCurrencySwap, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo (required).

Member Function Documentation

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.LusidInstrument.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.LusidInstrument.Equals ( LusidInstrument input )

inline

Returns true if LusidInstrument instances are equal

Parameters

input Instance of LusidInstrument to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ InstrumentType

InstrumentTypeEnum Lusid.Sdk.Model.LusidInstrument.InstrumentType

getset

The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CashSettled, CdsIndex, Basket, FundingLeg, CrossCurrencySwap, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo

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

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

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ InstrumentTypeEnum

Constructor & Destructor Documentation

◆ LusidInstrument() [1/2]

◆ LusidInstrument() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ InstrumentType