LUSID representation of a reference to another instrument that has already been loaded (e.g. a lookthrough to a portfolio). More...
Inheritance diagram for Lusid.Sdk.Model.ReferenceInstrument:
Public Member Functions | |
| ReferenceInstrument (string instrumentId=default(string), string instrumentIdType=default(string), string scope=default(string), InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum)) | |
| Initializes a new instance of the ReferenceInstrument class. More... | |
| override string | ToString () |
| Returns the string presentation of the object More... | |
| override 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 (ReferenceInstrument input) |
| Returns true if ReferenceInstrument instances are equal More... | |
| override int | GetHashCode () |
| Gets the hash code More... | |
 Public Member Functions inherited from Lusid.Sdk.Model.LusidInstrument | |
| 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... | |
| 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 | |
| ReferenceInstrument () | |
| Initializes a new instance of the ReferenceInstrument class. More... | |
| IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > | BaseValidate (ValidationContext validationContext) |
| To validate all properties of the instance More... | |
| Protected Member Functions inherited from Lusid.Sdk.Model.LusidInstrument | |
| 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 | |
| string | InstrumentId [get, set] |
| The Identifier code More... | |
| string | InstrumentIdType [get, set] |
| The type of the instrument id e.g. LusidInstrument Id More... | |
| string | Scope [get, set] |
| Scope for the instrument (optional) More... | |
| Properties inherited from Lusid.Sdk.Model.LusidInstrument | |
| 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 More... | |
Detailed Description
LUSID representation of a reference to another instrument that has already been loaded (e.g. a lookthrough to a portfolio).
Constructor & Destructor Documentation
◆ ReferenceInstrument() [1/2]
|
inlineprotected |
Initializes a new instance of the ReferenceInstrument class.
◆ ReferenceInstrument() [2/2]
|
inline |
Initializes a new instance of the ReferenceInstrument class.
- Parameters
-
instrumentId The Identifier code (required). instrumentIdType The type of the instrument id e.g. LusidInstrument Id (required). scope Scope for the instrument (optional) (required). 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 (required) (default to "ReferenceInstrument").
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 objects are equal
- Parameters
-
input Object to be compared
- Returns
- Boolean
◆ Equals() [2/2]
|
inline |
Returns true if ReferenceInstrument instances are equal
- Parameters
-
input Instance of ReferenceInstrument 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 from Lusid.Sdk.Model.LusidInstrument.
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ InstrumentId
|
getset |
The Identifier code
The Identifier code
◆ InstrumentIdType
|
getset |
The type of the instrument id e.g. LusidInstrument Id
The type of the instrument id e.g. LusidInstrument Id
◆ Scope
|
getset |
Scope for the instrument (optional)
Scope for the instrument (optional)
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/ReferenceInstrument.cs
