Definition of an exercise event. This is an event that occurs on transformation of an instrument owing to exercise. e.g. an option of some type into its underlying. More...
Inheritance diagram for Lusid.Sdk.Model.ExerciseEvent:
Public Member Functions | |
| ExerciseEvent (LusidInstrument instrument=default(LusidInstrument), DateTimeOffset anchorDate=default(DateTimeOffset), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum)) | |
| Initializes a new instance of the ExerciseEvent class. More... | |
| bool | ShouldSerializeEventWindowEnd () |
| Returns false as EventWindowEnd should not be serialized given that it's read-only. 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 (ExerciseEvent input) |
| Returns true if ExerciseEvent 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 | |
| ExerciseEvent () | |
| Initializes a new instance of the ExerciseEvent 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 | |
| LusidInstrument | Instrument [get, set] |
| Gets or Sets Instrument More... | |
| DateTimeOffset | AnchorDate [get, set] |
| The date the exercise window starts, or point it takes effect on. More... | |
| DateTimeOffset | EventWindowEnd [get] |
| The date the exercise window ends, or point it takes effect on. 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 More... | |
Detailed Description
Definition of an exercise event. This is an event that occurs on transformation of an instrument owing to exercise. e.g. an option of some type into its underlying.
Constructor & Destructor Documentation
◆ ExerciseEvent() [1/2]
|
inlineprotected |
Initializes a new instance of the ExerciseEvent class.
◆ ExerciseEvent() [2/2]
|
inline |
Initializes a new instance of the ExerciseEvent class.
- Parameters
-
instrument instrument (required). anchorDate The date the exercise window starts, or point it takes effect on. (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, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent (required) (default to "ExerciseEvent").
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 ExerciseEvent instances are equal
- Parameters
-
input Instance of ExerciseEvent 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
◆ ShouldSerializeEventWindowEnd()
|
inline |
Returns false as EventWindowEnd should not be serialized given that it's read-only.
- Returns
- false (boolean)
◆ 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
◆ AnchorDate
|
getset |
The date the exercise window starts, or point it takes effect on.
The date the exercise window starts, or point it takes effect on.
◆ EventWindowEnd
|
get |
The date the exercise window ends, or point it takes effect on.
The date the exercise window ends, or point it takes effect on.
◆ Instrument
|
getset |
Gets or Sets Instrument
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/ExerciseEvent.cs
