Public Types | |
| enum class | ScheduleTypeEnum { FixedSchedule = 1 , FloatSchedule = 2 , OptionalitySchedule = 3 , StepSchedule = 4 , Exercise = 5 , FxRateSchedule = 6 , FxLinkedNotionalSchedule = 7 , Invalid = 8 } |
| The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid More... | |
Public Member Functions | |
| FxRateScheduleAllOf (FlowConventions flowConventions=default(FlowConventions), List< string > fxConversionTypes=default(List< string >), decimal rate=default(decimal), string toCurrency=default(string), ScheduleTypeEnum scheduleType=default(ScheduleTypeEnum)) | |
| Initializes a new instance of the FxRateScheduleAllOf 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 (FxRateScheduleAllOf input) |
| Returns true if FxRateScheduleAllOf instances are equal More... | |
| override int | GetHashCode () |
| Gets the hash code More... | |
Protected Member Functions | |
| FxRateScheduleAllOf () | |
| Initializes a new instance of the FxRateScheduleAllOf class. More... | |
Properties | |
| ScheduleTypeEnum | ScheduleType [get, set] |
| The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid More... | |
| FlowConventions | FlowConventions [get, set] |
| Gets or Sets FlowConventions More... | |
| List< string > | FxConversionTypes [get, set] |
| List of flags to indicate if coupon payments, principal payments or both are converted More... | |
| decimal | Rate [get, set] |
| FxRate used to convert payments. Assumed to be in units of the ToCurrency so conversion is paymentAmount x fxRate More... | |
| string | ToCurrency [get, set] |
| Currency that payments are converted to More... | |
Detailed Description
Member Enumeration Documentation
◆ ScheduleTypeEnum
The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid
The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid
| Enumerator | |
|---|---|
| FixedSchedule | Enum FixedSchedule for value: FixedSchedule |
| FloatSchedule | Enum FloatSchedule for value: FloatSchedule |
| OptionalitySchedule | Enum OptionalitySchedule for value: OptionalitySchedule |
| StepSchedule | Enum StepSchedule for value: StepSchedule |
| Exercise | Enum Exercise for value: Exercise |
| FxRateSchedule | Enum FxRateSchedule for value: FxRateSchedule |
| FxLinkedNotionalSchedule | Enum FxLinkedNotionalSchedule for value: FxLinkedNotionalSchedule |
| Invalid | Enum Invalid for value: Invalid |
Constructor & Destructor Documentation
◆ FxRateScheduleAllOf() [1/2]
|
inlineprotected |
Initializes a new instance of the FxRateScheduleAllOf class.
◆ FxRateScheduleAllOf() [2/2]
|
inline |
Initializes a new instance of the FxRateScheduleAllOf class.
- Parameters
-
flowConventions flowConventions. fxConversionTypes List of flags to indicate if coupon payments, principal payments or both are converted. rate FxRate used to convert payments. Assumed to be in units of the ToCurrency so conversion is paymentAmount x fxRate. toCurrency Currency that payments are converted to. scheduleType The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid (required).
Member Function Documentation
◆ Equals() [1/2]
|
inline |
Returns true if FxRateScheduleAllOf instances are equal
- Parameters
-
input Instance of FxRateScheduleAllOf 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
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ FlowConventions
|
getset |
Gets or Sets FlowConventions
◆ FxConversionTypes
|
getset |
List of flags to indicate if coupon payments, principal payments or both are converted
List of flags to indicate if coupon payments, principal payments or both are converted
◆ Rate
|
getset |
FxRate used to convert payments. Assumed to be in units of the ToCurrency so conversion is paymentAmount x fxRate
FxRate used to convert payments. Assumed to be in units of the ToCurrency so conversion is paymentAmount x fxRate
◆ ScheduleType
|
getset |
The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid
The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid
◆ ToCurrency
|
getset |
Currency that payments are converted to
Currency that payments are converted to
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/FxRateScheduleAllOf.cs
