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

Definition of an Amortisation event. This is an event that describes the occurence of amortisation. More...

Inheritance diagram for Lusid.Sdk.Model.AmortisationEvent:
Inheritance graph
[legend]

Public Member Functions

 AmortisationEvent (decimal amountReduced=default(decimal), string domCcy=default(string), string payReceive=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...
 
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, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent 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
}
 The Type of Event. The available values are: 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 More...
 

Detailed Description

Definition of an Amortisation event. This is an event that describes the occurence of amortisation.

Constructor & Destructor Documentation

◆ AmortisationEvent() [1/2]

Lusid.Sdk.Model.AmortisationEvent.AmortisationEvent ( )
inlineprotected

Initializes a new instance of the AmortisationEvent class.

◆ AmortisationEvent() [2/2]

Lusid.Sdk.Model.AmortisationEvent.AmortisationEvent ( decimal  amountReduced = default(decimal),
string  domCcy = default(string),
string  payReceive = default(string),
DateTimeOffset  paymentDate = default(DateTimeOffset),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the AmortisationEvent class.

Parameters
amountReducedThe 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).
domCcyDomestic currency of the originating instrument (required).
payReceiveIs this event in relation to the Pay or Receive leg (required).
paymentDateThe date the principal payment is to be made. (required).
instrumentEventTypeThe Type of Event. The available values are: 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 (required) (default to "AmortisationEvent").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if AmortisationEvent instances are equal

Parameters
inputInstance of AmortisationEvent to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

override string Lusid.Sdk.Model.AmortisationEvent.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.AmortisationEvent.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AmountReduced

decimal Lusid.Sdk.Model.AmortisationEvent.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

string Lusid.Sdk.Model.AmortisationEvent.DomCcy
getset

Domestic currency of the originating instrument

Domestic currency of the originating instrument

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.AmortisationEvent.PaymentDate
getset

The date the principal payment is to be made.

The date the principal payment is to be made.

◆ PayReceive

string Lusid.Sdk.Model.AmortisationEvent.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: