Definition of a trigger event. This is an event that occurs on transformation of an option instrument being triggered by a barrier/touch price level being hit by the underlying asset. More...
Inheritance diagram for Lusid.Sdk.Model.TriggerEvent:
Public Member Functions | |
| TriggerEvent (decimal level=default(decimal), string triggerType=default(string), string triggerDirection=default(string), DateTimeOffset triggerDate=default(DateTimeOffset), DateTimeOffset maturityDate=default(DateTimeOffset), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum)) | |
| Initializes a new instance of the TriggerEvent 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 (TriggerEvent input) |
| Returns true if TriggerEvent 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 | |
| TriggerEvent () | |
| Initializes a new instance of the TriggerEvent 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... | |
Detailed Description
Definition of a trigger event. This is an event that occurs on transformation of an option instrument being triggered by a barrier/touch price level being hit by the underlying asset.
Constructor & Destructor Documentation
◆ TriggerEvent() [1/2]
|
inlineprotected |
Initializes a new instance of the TriggerEvent class.
◆ TriggerEvent() [2/2]
|
inline |
Initializes a new instance of the TriggerEvent class.
- Parameters
-
level The underlying price level that triggers the event (required). triggerType The type of the trigger; valid options are Knock-In, Knock-Out, Touch or No-Touch (required). triggerDirection The direction of the trigger; valid options are Up and Down (required). triggerDate The date the trigger happens at. (required). maturityDate The date the trigger takes effect. (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 "TriggerEvent").
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 objects are equal
- Parameters
-
input Object to be compared
- Returns
- Boolean
◆ Equals() [2/2]
|
inline |
Returns true if TriggerEvent instances are equal
- Parameters
-
input Instance of TriggerEvent 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
◆ Level
|
getset |
The underlying price level that triggers the event
The underlying price level that triggers the event
◆ MaturityDate
|
getset |
The date the trigger takes effect.
The date the trigger takes effect.
◆ TriggerDate
|
getset |
The date the trigger happens at.
The date the trigger happens at.
◆ TriggerDirection
|
getset |
The direction of the trigger; valid options are Up and Down
The direction of the trigger; valid options are Up and Down
◆ TriggerType
|
getset |
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/TriggerEvent.cs
