Definition of a cap or floor (or collar) cash flow event. This is an event that describes the occurence of a caplet or floorlet payment. More...

Inheritance diagram for Lusid.Sdk.Model.CapletFloorletCashFlowEvent:

[legend]

Public Member Functions
	CapletFloorletCashFlowEvent (DateTimeOffset entitlementDate=default(DateTimeOffset), DateTimeOffset paymentDate=default(DateTimeOffset), string currency=default(string), decimal cashFlowPerUnit=default(decimal), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the CapletFloorletCashFlowEvent 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 (CapletFloorletCashFlowEvent input)
	Returns true if CapletFloorletCashFlowEvent instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Public Member Functions inherited from Lusid.Sdk.Model.InstrumentEvent
	InstrumentEvent (InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the InstrumentEvent 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 (InstrumentEvent input)
	Returns true if InstrumentEvent instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	CapletFloorletCashFlowEvent ()
	Initializes a new instance of the CapletFloorletCashFlowEvent 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.InstrumentEvent
	InstrumentEvent ()
	Initializes a new instance of the InstrumentEvent class. More...

IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult >	BaseValidate (ValidationContext validationContext)
	To validate all properties of the instance More...

Properties
DateTimeOffset	EntitlementDate `[get, set]`
	Ex-Dividend / entitlement date of the cashflow payment. Required field. More...

DateTimeOffset	PaymentDate `[get, set]`
	Payment date of the cashflow payment Required field. More...

string	Currency `[get, set]`
	Currency of the cashflow payment More...

decimal	CashFlowPerUnit `[get, set]`
	The total payment per unit of the held instrument, if entitled. Not required. More...

Properties inherited from Lusid.Sdk.Model.InstrumentEvent
InstrumentEventTypeEnum	InstrumentEventType `[get, set]`
	The Type of Event. Available values: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent, RepurchaseOfferEvent, RepoPartialClosureEvent, RepoCashFlowEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, ConversionEvent, FlexibleRepoPartialClosureEvent, FlexibleRepoFullClosureEvent, CapletFloorletCashFlowEvent, EarlyCloseOutEvent, DepositRollEvent, ConsentEvent, DrawingEvent, CapitalGainsDistributionEvent. More...

Additional Inherited Members
Public Types inherited from Lusid.Sdk.Model.InstrumentEvent
enum class	InstrumentEventTypeEnum { TransitionEvent = 1 , InformationalEvent = 2 , OpenEvent = 3 , CloseEvent = 4 , StockSplitEvent = 5 , BondDefaultEvent = 6 , CashDividendEvent = 7 , AmortisationEvent = 8 , CashFlowEvent = 9 , ExerciseEvent = 10 , ResetEvent = 11 , TriggerEvent = 12 , RawVendorEvent = 13 , InformationalErrorEvent = 14 , BondCouponEvent = 15 , DividendReinvestmentEvent = 16 , AccumulationEvent = 17 , BondPrincipalEvent = 18 , DividendOptionEvent = 19 , MaturityEvent = 20 , FxForwardSettlementEvent = 21 , ExpiryEvent = 22 , ScripDividendEvent = 23 , StockDividendEvent = 24 , ReverseStockSplitEvent = 25 , CapitalDistributionEvent = 26 , SpinOffEvent = 27 , MergerEvent = 28 , FutureExpiryEvent = 29 , SwapCashFlowEvent = 30 , SwapPrincipalEvent = 31 , CreditPremiumCashFlowEvent = 32 , CdsCreditEvent = 33 , CdxCreditEvent = 34 , MbsCouponEvent = 35 , MbsPrincipalEvent = 36 , BonusIssueEvent = 37 , MbsPrincipalWriteOffEvent = 38 , MbsInterestDeferralEvent = 39 , MbsInterestShortfallEvent = 40 , TenderEvent = 41 , CallOnIntermediateSecuritiesEvent = 42 , IntermediateSecuritiesDistributionEvent = 43 , OptionExercisePhysicalEvent = 44 , OptionExerciseCashEvent = 45 , ProtectionPayoutCashFlowEvent = 46 , TermDepositInterestEvent = 47 , TermDepositPrincipalEvent = 48 , EarlyRedemptionEvent = 49 , FutureMarkToMarketEvent = 50 , AdjustGlobalCommitmentEvent = 51 , ContractInitialisationEvent = 52 , DrawdownEvent = 53 , LoanInterestRepaymentEvent = 54 , UpdateDepositAmountEvent = 55 , LoanPrincipalRepaymentEvent = 56 , DepositInterestPaymentEvent = 57 , DepositCloseEvent = 58 , LoanFacilityContractRolloverEvent = 59 , RepurchaseOfferEvent = 60 , RepoPartialClosureEvent = 61 , RepoCashFlowEvent = 62 , FlexibleRepoInterestPaymentEvent = 63 , FlexibleRepoCashFlowEvent = 64 , FlexibleRepoCollateralEvent = 65 , ConversionEvent = 66 , FlexibleRepoPartialClosureEvent = 67 , FlexibleRepoFullClosureEvent = 68 , CapletFloorletCashFlowEvent = 69 , EarlyCloseOutEvent = 70 , DepositRollEvent = 71 , ConsentEvent = 72 , DrawingEvent = 73 , CapitalGainsDistributionEvent = 74 }
	The Type of Event. Available values: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent, RepurchaseOfferEvent, RepoPartialClosureEvent, RepoCashFlowEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, ConversionEvent, FlexibleRepoPartialClosureEvent, FlexibleRepoFullClosureEvent, CapletFloorletCashFlowEvent, EarlyCloseOutEvent, DepositRollEvent, ConsentEvent, DrawingEvent, CapitalGainsDistributionEvent. More...

Detailed Description

Definition of a cap or floor (or collar) cash flow event. This is an event that describes the occurence of a caplet or floorlet payment.

Constructor & Destructor Documentation

◆ CapletFloorletCashFlowEvent() [1/2]

Lusid.Sdk.Model.CapletFloorletCashFlowEvent.CapletFloorletCashFlowEvent ( )

inlineprotected

Initializes a new instance of the CapletFloorletCashFlowEvent class.

◆ CapletFloorletCashFlowEvent() [2/2]

Lusid.Sdk.Model.CapletFloorletCashFlowEvent.CapletFloorletCashFlowEvent	(	DateTimeOffset	entitlementDate = `default(DateTimeOffset)`,
		DateTimeOffset	paymentDate = `default(DateTimeOffset)`,
		string	currency = `default(string)`,
		decimal	cashFlowPerUnit = `default(decimal)`,
		InstrumentEventTypeEnum	instrumentEventType = `default(InstrumentEventTypeEnum)`
	)

inline

Initializes a new instance of the CapletFloorletCashFlowEvent class.

Parameters

entitlementDate	Ex-Dividend / entitlement date of the cashflow payment. Required field..
paymentDate	Payment date of the cashflow payment Required field..
currency	Currency of the cashflow payment (required).
cashFlowPerUnit	The total payment per unit of the held instrument, if entitled. Not required. (required).
instrumentEventType	The Type of Event. Available values: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent, RepurchaseOfferEvent, RepoPartialClosureEvent, RepoCashFlowEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, ConversionEvent, FlexibleRepoPartialClosureEvent, FlexibleRepoFullClosureEvent, CapletFloorletCashFlowEvent, EarlyCloseOutEvent, DepositRollEvent, ConsentEvent, DrawingEvent, CapitalGainsDistributionEvent. (required) (default to "CapletFloorletCashFlowEvent").

Member Function Documentation

◆ BaseValidate()

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

inlineprotected

To validate all properties of the instance

Parameters

validationContext Validation context

Returns: Validation Result

◆ Equals() [1/2]

bool Lusid.Sdk.Model.CapletFloorletCashFlowEvent.Equals ( CapletFloorletCashFlowEvent input )

inline

Returns true if CapletFloorletCashFlowEvent instances are equal

Parameters

input Instance of CapletFloorletCashFlowEvent to be compared

Returns: Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.CapletFloorletCashFlowEvent.Equals ( object input )

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.CapletFloorletCashFlowEvent.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

override string Lusid.Sdk.Model.CapletFloorletCashFlowEvent.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.InstrumentEvent.

◆ ToString()

override string Lusid.Sdk.Model.CapletFloorletCashFlowEvent.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ CashFlowPerUnit

decimal Lusid.Sdk.Model.CapletFloorletCashFlowEvent.CashFlowPerUnit

getset

The total payment per unit of the held instrument, if entitled. Not required.

◆ Currency

string Lusid.Sdk.Model.CapletFloorletCashFlowEvent.Currency

getset

Currency of the cashflow payment

◆ EntitlementDate

DateTimeOffset Lusid.Sdk.Model.CapletFloorletCashFlowEvent.EntitlementDate

getset

Ex-Dividend / entitlement date of the cashflow payment. Required field.

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.CapletFloorletCashFlowEvent.PaymentDate

getset

Payment date of the cashflow payment Required field.

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/CapletFloorletCashFlowEvent.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CapletFloorletCashFlowEvent() [1/2]

◆ CapletFloorletCashFlowEvent() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ CashFlowPerUnit

◆ Currency

◆ EntitlementDate

◆ PaymentDate