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

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:
Inheritance graph
[legend]

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, 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 , Invalid = 8
}
 The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, 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]

Lusid.Sdk.Model.FxLinkedNotionalSchedule.FxLinkedNotionalSchedule ( )
inlineprotected

Initializes a new instance of the FxLinkedNotionalSchedule class.

◆ FxLinkedNotionalSchedule() [2/2]

Lusid.Sdk.Model.FxLinkedNotionalSchedule.FxLinkedNotionalSchedule ( FxConventions  fxConventions = default(FxConventions),
string  varyingNotionalCurrency = default(string),
RelativeDateOffset  varyingNotionalFixingDates = default(RelativeDateOffset),
RelativeDateOffset  varyingNotionalInterimExchangePaymentDates = default(RelativeDateOffset),
ScheduleTypeEnum  scheduleType = default(ScheduleTypeEnum) 
)
inline

Initializes a new instance of the FxLinkedNotionalSchedule class.

Parameters
fxConventionsfxConventions (required).
varyingNotionalCurrencyThe currency of the varying notional amount. (required).
varyingNotionalFixingDatesvaryingNotionalFixingDates (required).
varyingNotionalInterimExchangePaymentDatesvaryingNotionalInterimExchangePaymentDates.
scheduleTypeThe available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid (required) (default to "FxLinkedNotionalSchedule").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if FxLinkedNotionalSchedule instances are equal

Parameters
inputInstance of FxLinkedNotionalSchedule to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.Schedule.

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ FxConventions

FxConventions Lusid.Sdk.Model.FxLinkedNotionalSchedule.FxConventions
getset

Gets or Sets FxConventions

◆ VaryingNotionalCurrency

string Lusid.Sdk.Model.FxLinkedNotionalSchedule.VaryingNotionalCurrency
getset

The currency of the varying notional amount.

The currency of the varying notional amount.

◆ VaryingNotionalFixingDates

RelativeDateOffset Lusid.Sdk.Model.FxLinkedNotionalSchedule.VaryingNotionalFixingDates
getset

Gets or Sets VaryingNotionalFixingDates

◆ VaryingNotionalInterimExchangePaymentDates

RelativeDateOffset Lusid.Sdk.Model.FxLinkedNotionalSchedule.VaryingNotionalInterimExchangePaymentDates
getset

Gets or Sets VaryingNotionalInterimExchangePaymentDates


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