Base class in the hierarchy for representing the full economic definition of instruments in LUSID. These definitions are used to provide instrument analytics such as PV, accrual, cash flows, and risk. This base class should not be directly instantiated; each supported InstrumentType has a corresponding inherited class. 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... | |
| IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > | BaseValidate (ValidationContext validationContext) |
| To validate all properties of the instance 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, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg More... | |
Detailed Description
Base class in the hierarchy for representing the full economic definition of instruments in LUSID. These definitions are used to provide instrument analytics such as PV, accrual, cash flows, and risk. This base class should not be directly instantiated; each supported InstrumentType has a corresponding inherited class.
Member Enumeration Documentation
◆ InstrumentTypeEnum
The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg
The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg
| Enumerator | |
|---|---|
| QuotedSecurity | Enum QuotedSecurity for value: QuotedSecurity |
| InterestRateSwap | Enum InterestRateSwap for value: InterestRateSwap |
| FxForward | |
| Future | |
| ExoticInstrument | Enum ExoticInstrument for value: ExoticInstrument |
| FxOption | |
| CreditDefaultSwap | Enum CreditDefaultSwap for value: CreditDefaultSwap |
| InterestRateSwaption | Enum InterestRateSwaption for value: InterestRateSwaption |
| Bond | |
| EquityOption | Enum EquityOption for value: EquityOption |
| 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 |
| CapFloor | |
| CashSettled | Enum CashSettled for value: CashSettled |
| CdsIndex | |
| Basket | |
| FundingLeg | Enum FundingLeg for value: FundingLeg |
| FxSwap | |
| ForwardRateAgreement | Enum ForwardRateAgreement for value: ForwardRateAgreement |
| SimpleInstrument | Enum SimpleInstrument for value: SimpleInstrument |
| Repo | |
| Equity | |
| ExchangeTradedOption | Enum ExchangeTradedOption for value: ExchangeTradedOption |
| ReferenceInstrument | Enum ReferenceInstrument for value: ReferenceInstrument |
| ComplexBond | Enum ComplexBond for value: ComplexBond |
| InflationLinkedBond | Enum InflationLinkedBond for value: InflationLinkedBond |
| InflationSwap | Enum InflationSwap for value: InflationSwap |
| SimpleCashFlowLoan | Enum SimpleCashFlowLoan for value: SimpleCashFlowLoan |
| TotalReturnSwap | Enum TotalReturnSwap for value: TotalReturnSwap |
| InflationLeg | Enum InflationLeg for value: InflationLeg |
Constructor & Destructor Documentation
◆ LusidInstrument() [1/2]
|
inlineprotected |
Initializes a new instance of the LusidInstrument class.
◆ LusidInstrument() [2/2]
|
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, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg (required).
Member Function Documentation
◆ BaseValidate()
|
inlineprotected |
To validate all properties of the instance
- Parameters
-
validationContext Validation context
- Returns
- Validation Result
◆ Equals() [1/2]
|
inline |
Returns true if LusidInstrument instances are equal
- Parameters
-
input Instance of LusidInstrument to be compared
- Returns
- Boolean
◆ Equals() [2/2]
|
inline |
Returns true if objects are equal
- Parameters
-
input Object to be compared
- Returns
- Boolean
◆ GetHashCode()
|
inline |
Gets the hash code
- Returns
- Hash code
◆ ToJson()
|
inlinevirtual |
Returns the JSON string presentation of the object
- Returns
- JSON string presentation of the object
Reimplemented in Lusid.Sdk.Model.TotalReturnSwap, Lusid.Sdk.Model.TermDeposit, Lusid.Sdk.Model.SimpleInstrument, Lusid.Sdk.Model.SimpleCashFlowLoan, Lusid.Sdk.Model.Repo, Lusid.Sdk.Model.ReferenceInstrument, Lusid.Sdk.Model.InterestRateSwaption, Lusid.Sdk.Model.InterestRateSwap, Lusid.Sdk.Model.InstrumentLeg, Lusid.Sdk.Model.InflationSwap, Lusid.Sdk.Model.InflationLinkedBond, Lusid.Sdk.Model.InflationLeg, Lusid.Sdk.Model.FxSwap, Lusid.Sdk.Model.FxOption, Lusid.Sdk.Model.FxForward, Lusid.Sdk.Model.Future, Lusid.Sdk.Model.FundingLeg, Lusid.Sdk.Model.ForwardRateAgreement, Lusid.Sdk.Model.FloatingLeg, Lusid.Sdk.Model.FixedLeg, Lusid.Sdk.Model.ExoticInstrument, Lusid.Sdk.Model.ExchangeTradedOption, Lusid.Sdk.Model.EquitySwap, Lusid.Sdk.Model.EquityOption, Lusid.Sdk.Model.Equity, Lusid.Sdk.Model.CreditDefaultSwap, Lusid.Sdk.Model.ContractForDifference, Lusid.Sdk.Model.ComplexBond, Lusid.Sdk.Model.CdsIndex, Lusid.Sdk.Model.CashPerpetual, Lusid.Sdk.Model.CapFloor, Lusid.Sdk.Model.Bond, and Lusid.Sdk.Model.Basket.
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ InstrumentType
|
getset |
The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg
The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg
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/LusidInstrument.cs
