Definition of an Amortisation event. This is an event that describes the occurence of amortisation. More...
Inheritance diagram for Lusid.Sdk.Model.AmortisationEvent:
Public Member Functions | |
| AmortisationEvent (decimal amountReduced=default(decimal), string domCcy=default(string), string payReceive=default(string), string eventStatus=default(string), DateTimeOffset paymentDate=default(DateTimeOffset), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum)) | |
| Initializes a new instance of the AmortisationEvent 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 (AmortisationEvent input) |
| Returns true if AmortisationEvent 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 | |
| AmortisationEvent () | |
| Initializes a new instance of the AmortisationEvent 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 | |
| decimal | AmountReduced [get, set] |
| The amount reduced in this amortisation event. That is, the difference between the previous notional amount and the current notional amount as set in this event. More... | |
| string | DomCcy [get, set] |
| Domestic currency of the originating instrument More... | |
| string | PayReceive [get, set] |
| Is this event in relation to the Pay or Receive leg More... | |
| string | EventStatus [get, set] |
| What is the event status, is it a known (ie historic) or unknown (ie projected) event? More... | |
| DateTimeOffset | PaymentDate [get, set] |
| The date the principal payment is to be made. More... | |
| Properties inherited from Lusid.Sdk.Model.InstrumentEvent | |
| InstrumentEventTypeEnum | InstrumentEventType [get, set] |
| The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent 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 } |
| The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent More... | |
Detailed Description
Definition of an Amortisation event. This is an event that describes the occurence of amortisation.
Constructor & Destructor Documentation
◆ AmortisationEvent() [1/2]
|
inlineprotected |
Initializes a new instance of the AmortisationEvent class.
◆ AmortisationEvent() [2/2]
|
inline |
Initializes a new instance of the AmortisationEvent class.
- Parameters
-
amountReduced The amount reduced in this amortisation event. That is, the difference between the previous notional amount and the current notional amount as set in this event. (required). domCcy Domestic currency of the originating instrument (required). payReceive Is this event in relation to the Pay or Receive leg (required). eventStatus What is the event status, is it a known (ie historic) or unknown (ie projected) event? (required). paymentDate The date the principal payment is to be made. (required). instrumentEventType The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent (required) (default to "AmortisationEvent").
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 AmortisationEvent instances are equal
- Parameters
-
input Instance of AmortisationEvent 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.InstrumentEvent.
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ AmountReduced
|
getset |
The amount reduced in this amortisation event. That is, the difference between the previous notional amount and the current notional amount as set in this event.
The amount reduced in this amortisation event. That is, the difference between the previous notional amount and the current notional amount as set in this event.
◆ DomCcy
|
getset |
Domestic currency of the originating instrument
Domestic currency of the originating instrument
◆ EventStatus
|
getset |
What is the event status, is it a known (ie historic) or unknown (ie projected) event?
What is the event status, is it a known (ie historic) or unknown (ie projected) event?
◆ PaymentDate
|
getset |
The date the principal payment is to be made.
The date the principal payment is to be made.
◆ PayReceive
|
getset |
Is this event in relation to the Pay or Receive leg
Is this event in relation to the Pay or Receive leg
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/AmortisationEvent.cs
