LUSID C# SDK
Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.InterestRateSwap Class Reference

LUSID representation of an Interest Rate Swap, including: * Vanilla (single currency fixed-float non-amortising) * CrossCurrency (>1 currency is used by the swap legs) * Basis (single currency, floating-floating legs of different tenors) * Amortising (the swap has 1+ leg with amortised notional) This instrument has multiple legs, to see how legs are used in LUSID see knowledge base article KA-02252. | Leg Index | Leg Identifier | Description | | - – – – – | - – – – – – – - | - – – – – – | | 1 | Pay/Receive | Cash flows representing the pay/receive leg. | | 2 | Receive/Pay | Cash flows representing the receive/pay leg. | | 3 | AdditionalPayments | Cash flows relating to any additional payments (optional). | More...

Inheritance diagram for Lusid.Sdk.Model.InterestRateSwap:
Inheritance graph
[legend]

Public Member Functions

 InterestRateSwap (DateTimeOffset startDate=default(DateTimeOffset), DateTimeOffset maturityDate=default(DateTimeOffset), bool isNonDeliverable=default(bool), List< InstrumentLeg > legs=default(List< InstrumentLeg >), string settlementCcy=default(string), List< AdditionalPayment > additionalPayments=default(List< AdditionalPayment >), InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
 Initializes a new instance of the InterestRateSwap 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 (InterestRateSwap input)
 Returns true if InterestRateSwap 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

 InterestRateSwap ()
 Initializes a new instance of the InterestRateSwap 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

DateTimeOffset StartDate [get, set]
 The start date of the instrument. This is normally synonymous with the trade-date. More...
 
DateTimeOffset MaturityDate [get, set]
 The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it. More...
 
bool IsNonDeliverable [get, set]
 Is the contract an IRS of &quot;Non-Deliverable&quot; type, meaning a single payment in the settlement currency based on the difference between the fixed and floating rates. More...
 
List< InstrumentLegLegs [get, set]
 The set of instrument legs that define the swap instrument, these should be FloatingLeg or FixedLeg. More...
 
string SettlementCcy [get, set]
 Settlement currency if IRS is non-deliverable. More...
 
List< AdditionalPaymentAdditionalPayments [get, set]
 Optional additional payments at a given date e.g. to level off an uneven fixed-floating swap. The dates must be distinct and either all payments are Pay or all payments are receive 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, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan More...
 

Additional Inherited Members

- Public Types inherited from Lusid.Sdk.Model.LusidInstrument
enum class  InstrumentTypeEnum {
  QuotedSecurity = 1 , InterestRateSwap = 2 , FxForward = 3 , Future = 4 ,
  ExoticInstrument = 5 , FxOption = 6 , CreditDefaultSwap = 7 , InterestRateSwaption = 8 ,
  Bond = 9 , EquityOption = 10 , FixedLeg = 11 , FloatingLeg = 12 ,
  BespokeCashFlowsLeg = 13 , Unknown = 14 , TermDeposit = 15 , ContractForDifference = 16 ,
  EquitySwap = 17 , CashPerpetual = 18 , CapFloor = 19 , CashSettled = 20 ,
  CdsIndex = 21 , Basket = 22 , FundingLeg = 23 , FxSwap = 24 ,
  ForwardRateAgreement = 25 , SimpleInstrument = 26 , Repo = 27 , Equity = 28 ,
  ExchangeTradedOption = 29 , ReferenceInstrument = 30 , ComplexBond = 31 , InflationLinkedBond = 32 ,
  InflationSwap = 33 , SimpleCashFlowLoan = 34 , TotalReturnSwap = 35 , InflationLeg = 36 ,
  FundShareClass = 37 , FlexibleLoan = 38
}
 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, FundShareClass, FlexibleLoan More...
 

Detailed Description

LUSID representation of an Interest Rate Swap, including: * Vanilla (single currency fixed-float non-amortising) * CrossCurrency (>1 currency is used by the swap legs) * Basis (single currency, floating-floating legs of different tenors) * Amortising (the swap has 1+ leg with amortised notional) This instrument has multiple legs, to see how legs are used in LUSID see knowledge base article KA-02252. | Leg Index | Leg Identifier | Description | | - – – – – | - – – – – – – - | - – – – – – | | 1 | Pay/Receive | Cash flows representing the pay/receive leg. | | 2 | Receive/Pay | Cash flows representing the receive/pay leg. | | 3 | AdditionalPayments | Cash flows relating to any additional payments (optional). |

Constructor & Destructor Documentation

◆ InterestRateSwap() [1/2]

Lusid.Sdk.Model.InterestRateSwap.InterestRateSwap ( )
inlineprotected

Initializes a new instance of the InterestRateSwap class.

◆ InterestRateSwap() [2/2]

Lusid.Sdk.Model.InterestRateSwap.InterestRateSwap ( DateTimeOffset  startDate = default(DateTimeOffset),
DateTimeOffset  maturityDate = default(DateTimeOffset),
bool  isNonDeliverable = default(bool),
List< InstrumentLeg legs = default(List<InstrumentLeg>),
string  settlementCcy = default(string),
List< AdditionalPayment additionalPayments = default(List<AdditionalPayment>),
InstrumentTypeEnum  instrumentType = default(InstrumentTypeEnum) 
)
inline

Initializes a new instance of the InterestRateSwap class.

Parameters
startDateThe start date of the instrument. This is normally synonymous with the trade-date. (required).
maturityDateThe final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it. (required).
isNonDeliverableIs the contract an IRS of &quot;Non-Deliverable&quot; type, meaning a single payment in the settlement currency based on the difference between the fixed and floating rates..
legsThe set of instrument legs that define the swap instrument, these should be FloatingLeg or FixedLeg. (required).
settlementCcySettlement currency if IRS is non-deliverable..
additionalPaymentsOptional additional payments at a given date e.g. to level off an uneven fixed-floating swap. The dates must be distinct and either all payments are Pay or all payments are receive.
instrumentTypeThe 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, FundShareClass, FlexibleLoan (required) (default to "InterestRateSwap").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.InterestRateSwap.BaseValidate ( ValidationContext  validationContext)
inlineprotected

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

bool Lusid.Sdk.Model.InterestRateSwap.Equals ( InterestRateSwap  input)
inline

Returns true if InterestRateSwap instances are equal

Parameters
inputInstance of InterestRateSwap to be compared
Returns
Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.InterestRateSwap.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.InterestRateSwap.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

override string Lusid.Sdk.Model.InterestRateSwap.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.LusidInstrument.

◆ ToString()

override string Lusid.Sdk.Model.InterestRateSwap.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AdditionalPayments

List<AdditionalPayment> Lusid.Sdk.Model.InterestRateSwap.AdditionalPayments
getset

Optional additional payments at a given date e.g. to level off an uneven fixed-floating swap. The dates must be distinct and either all payments are Pay or all payments are receive

Optional additional payments at a given date e.g. to level off an uneven fixed-floating swap. The dates must be distinct and either all payments are Pay or all payments are receive

◆ IsNonDeliverable

bool Lusid.Sdk.Model.InterestRateSwap.IsNonDeliverable
getset

Is the contract an IRS of &quot;Non-Deliverable&quot; type, meaning a single payment in the settlement currency based on the difference between the fixed and floating rates.

Is the contract an IRS of &quot;Non-Deliverable&quot; type, meaning a single payment in the settlement currency based on the difference between the fixed and floating rates.

◆ Legs

List<InstrumentLeg> Lusid.Sdk.Model.InterestRateSwap.Legs
getset

The set of instrument legs that define the swap instrument, these should be FloatingLeg or FixedLeg.

The set of instrument legs that define the swap instrument, these should be FloatingLeg or FixedLeg.

◆ MaturityDate

DateTimeOffset Lusid.Sdk.Model.InterestRateSwap.MaturityDate
getset

The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it.

The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it.

◆ SettlementCcy

string Lusid.Sdk.Model.InterestRateSwap.SettlementCcy
getset

Settlement currency if IRS is non-deliverable.

Settlement currency if IRS is non-deliverable.

◆ StartDate

DateTimeOffset Lusid.Sdk.Model.InterestRateSwap.StartDate
getset

The start date of the instrument. This is normally synonymous with the trade-date.

The start date of the instrument. This is normally synonymous with the trade-date.


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