Base class for representing instrument events in LUSID, such as dividends, stock splits, and option exercises. This base class should not be directly instantiated; each supported InstrumentEventType has a corresponding inherited class. More...
Public Member Functions | |
| 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... | |
| 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 (InstrumentEvent input) |
| Returns true if InstrumentEvent instances are equal More... | |
| override int | GetHashCode () |
| Gets the hash code More... | |
Protected Member Functions | |
| 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 | |
| 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 More... | |
Detailed Description
Base class for representing instrument events in LUSID, such as dividends, stock splits, and option exercises. This base class should not be directly instantiated; each supported InstrumentEventType has a corresponding inherited class.
Member Enumeration Documentation
◆ InstrumentEventTypeEnum
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
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
| Enumerator | |
|---|---|
| TransitionEvent | Enum TransitionEvent for value: TransitionEvent |
| InformationalEvent | Enum InformationalEvent for value: InformationalEvent |
| OpenEvent | |
| CloseEvent | Enum CloseEvent for value: CloseEvent |
| StockSplitEvent | Enum StockSplitEvent for value: StockSplitEvent |
| BondDefaultEvent | Enum BondDefaultEvent for value: BondDefaultEvent |
| CashDividendEvent | Enum CashDividendEvent for value: CashDividendEvent |
| AmortisationEvent | Enum AmortisationEvent for value: AmortisationEvent |
| CashFlowEvent | Enum CashFlowEvent for value: CashFlowEvent |
| ExerciseEvent | Enum ExerciseEvent for value: ExerciseEvent |
| ResetEvent | Enum ResetEvent for value: ResetEvent |
| TriggerEvent | Enum TriggerEvent for value: TriggerEvent |
| RawVendorEvent | Enum RawVendorEvent for value: RawVendorEvent |
| InformationalErrorEvent | Enum InformationalErrorEvent for value: InformationalErrorEvent |
| BondCouponEvent | Enum BondCouponEvent for value: BondCouponEvent |
| DividendReinvestmentEvent | Enum DividendReinvestmentEvent for value: DividendReinvestmentEvent |
| AccumulationEvent | Enum AccumulationEvent for value: AccumulationEvent |
| BondPrincipalEvent | Enum BondPrincipalEvent for value: BondPrincipalEvent |
| DividendOptionEvent | Enum DividendOptionEvent for value: DividendOptionEvent |
| MaturityEvent | Enum MaturityEvent for value: MaturityEvent |
| FxForwardSettlementEvent | Enum FxForwardSettlementEvent for value: FxForwardSettlementEvent |
| ExpiryEvent | Enum ExpiryEvent for value: ExpiryEvent |
| ScripDividendEvent | Enum ScripDividendEvent for value: ScripDividendEvent |
| StockDividendEvent | Enum StockDividendEvent for value: StockDividendEvent |
| ReverseStockSplitEvent | Enum ReverseStockSplitEvent for value: ReverseStockSplitEvent |
Constructor & Destructor Documentation
◆ InstrumentEvent() [1/2]
|
inlineprotected |
Initializes a new instance of the InstrumentEvent class.
◆ InstrumentEvent() [2/2]
|
inline |
Initializes a new instance of the InstrumentEvent class.
- Parameters
-
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, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent (required).
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 InstrumentEvent instances are equal
- Parameters
-
input Instance of InstrumentEvent 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 in Lusid.Sdk.Model.TriggerEvent, Lusid.Sdk.Model.TransitionEvent, Lusid.Sdk.Model.StockSplitEvent, Lusid.Sdk.Model.StockDividendEvent, Lusid.Sdk.Model.ScripDividendEvent, Lusid.Sdk.Model.ReverseStockSplitEvent, Lusid.Sdk.Model.ResetEvent, Lusid.Sdk.Model.RawVendorEvent, Lusid.Sdk.Model.OpenEvent, Lusid.Sdk.Model.MaturityEvent, Lusid.Sdk.Model.InformationalEvent, Lusid.Sdk.Model.InformationalErrorEvent, Lusid.Sdk.Model.FxForwardSettlementEvent, Lusid.Sdk.Model.ExpiryEvent, Lusid.Sdk.Model.ExerciseEvent, Lusid.Sdk.Model.DividendReinvestmentEvent, Lusid.Sdk.Model.DividendOptionEvent, Lusid.Sdk.Model.CloseEvent, Lusid.Sdk.Model.CashFlowEvent, Lusid.Sdk.Model.CashDividendEvent, Lusid.Sdk.Model.BondPrincipalEvent, Lusid.Sdk.Model.BondDefaultEvent, Lusid.Sdk.Model.BondCouponEvent, Lusid.Sdk.Model.AmortisationEvent, and Lusid.Sdk.Model.AccumulationEvent.
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ InstrumentEventType
|
getset |
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
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
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/InstrumentEvent.cs
