Schedule for notional changes based on the change in FX rate. Used in the representation of a resettable cross currency interest rate swap. More...
Inheritance diagram for Lusid.Sdk.Model.FxLinkedNotionalSchedule:
Public Member Functions | |
| FxLinkedNotionalSchedule (FxConventions fxConventions=default(FxConventions), string varyingNotionalCurrency=default(string), RelativeDateOffset varyingNotionalFixingDates=default(RelativeDateOffset), RelativeDateOffset varyingNotionalInterimExchangePaymentDates=default(RelativeDateOffset), ScheduleTypeEnum scheduleType=default(ScheduleTypeEnum)) | |
| Initializes a new instance of the FxLinkedNotionalSchedule 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 (FxLinkedNotionalSchedule input) |
| Returns true if FxLinkedNotionalSchedule instances are equal More... | |
| override int | GetHashCode () |
| Gets the hash code More... | |
 Public Member Functions inherited from Lusid.Sdk.Model.Schedule | |
| Schedule (ScheduleTypeEnum scheduleType=default(ScheduleTypeEnum)) | |
| Initializes a new instance of the Schedule 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 (Schedule input) |
| Returns true if Schedule instances are equal More... | |
| override int | GetHashCode () |
| Gets the hash code More... | |
Protected Member Functions | |
| FxLinkedNotionalSchedule () | |
| Initializes a new instance of the FxLinkedNotionalSchedule 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.Schedule | |
| Schedule () | |
| Initializes a new instance of the Schedule class. More... | |
| IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > | BaseValidate (ValidationContext validationContext) |
| To validate all properties of the instance More... | |
Properties | |
| FxConventions | FxConventions [get, set] |
| Gets or Sets FxConventions More... | |
| string | VaryingNotionalCurrency [get, set] |
| The currency of the varying notional amount. More... | |
| RelativeDateOffset | VaryingNotionalFixingDates [get, set] |
| Gets or Sets VaryingNotionalFixingDates More... | |
| RelativeDateOffset | VaryingNotionalInterimExchangePaymentDates [get, set] |
| Gets or Sets VaryingNotionalInterimExchangePaymentDates More... | |
| Properties inherited from Lusid.Sdk.Model.Schedule | |
| ScheduleTypeEnum | ScheduleType [get, set] |
| The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid More... | |
Additional Inherited Members | |
| Public Types inherited from Lusid.Sdk.Model.Schedule | |
| enum class | ScheduleTypeEnum { FixedSchedule = 1 , FloatSchedule = 2 , OptionalitySchedule = 3 , StepSchedule = 4 , Exercise = 5 , FxRateSchedule = 6 , FxLinkedNotionalSchedule = 7 , BondConversionSchedule = 8 , Invalid = 9 } |
| The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid More... | |
Detailed Description
Schedule for notional changes based on the change in FX rate. Used in the representation of a resettable cross currency interest rate swap.
Constructor & Destructor Documentation
◆ FxLinkedNotionalSchedule() [1/2]
|
inlineprotected |
Initializes a new instance of the FxLinkedNotionalSchedule class.
◆ FxLinkedNotionalSchedule() [2/2]
|
inline |
Initializes a new instance of the FxLinkedNotionalSchedule class.
- Parameters
-
fxConventions fxConventions (required). varyingNotionalCurrency The currency of the varying notional amount. (required). varyingNotionalFixingDates varyingNotionalFixingDates (required). varyingNotionalInterimExchangePaymentDates varyingNotionalInterimExchangePaymentDates. scheduleType The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid (required) (default to "FxLinkedNotionalSchedule").
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 FxLinkedNotionalSchedule instances are equal
- Parameters
-
input Instance of FxLinkedNotionalSchedule 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 from Lusid.Sdk.Model.Schedule.
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ FxConventions
|
getset |
Gets or Sets FxConventions
◆ VaryingNotionalCurrency
|
getset |
The currency of the varying notional amount.
The currency of the varying notional amount.
◆ VaryingNotionalFixingDates
|
getset |
Gets or Sets VaryingNotionalFixingDates
◆ VaryingNotionalInterimExchangePaymentDates
|
getset |
Gets or Sets VaryingNotionalInterimExchangePaymentDates
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/FxLinkedNotionalSchedule.cs
