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:

[legend]

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...

Properties
decimal	Level `[get, set]`
	The underlying price level that triggers the event More...

string	TriggerType `[get, set]`
	The type of the trigger; valid options are Knock-In, Knock-Out, Touch or No-Touch More...

string	TriggerDirection `[get, set]`
	The direction of the trigger; valid options are Up and Down More...

DateTimeOffset	TriggerDate `[get, set]`
	The date the trigger happens at. More...

DateTimeOffset	MaturityDate `[get, set]`
	The date the trigger takes effect. 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 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]

Lusid.Sdk.Model.TriggerEvent.TriggerEvent ( )

inlineprotected

Initializes a new instance of the TriggerEvent class.

◆ TriggerEvent() [2/2]

Lusid.Sdk.Model.TriggerEvent.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)`
	)

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 (required) (default to "TriggerEvent").

Member Function Documentation

◆ BaseValidate()

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

inlineprotected

To validate all properties of the instance

Parameters

validationContext Validation context

Returns: Validation Result

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.TriggerEvent.Equals ( object input )

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool Lusid.Sdk.Model.TriggerEvent.Equals ( TriggerEvent input )

inline

Returns true if TriggerEvent instances are equal

Parameters

input Instance of TriggerEvent to be compared

Returns: Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.TriggerEvent.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ Level

decimal Lusid.Sdk.Model.TriggerEvent.Level

getset

The underlying price level that triggers the event

◆ MaturityDate

DateTimeOffset Lusid.Sdk.Model.TriggerEvent.MaturityDate

getset

The date the trigger takes effect.

◆ TriggerDate

DateTimeOffset Lusid.Sdk.Model.TriggerEvent.TriggerDate

getset

The date the trigger happens at.

◆ TriggerDirection

string Lusid.Sdk.Model.TriggerEvent.TriggerDirection

getset

The direction of the trigger; valid options are Up and Down

◆ TriggerType

string Lusid.Sdk.Model.TriggerEvent.TriggerType

getset

The type of the trigger; valid options are Knock-In, Knock-Out, Touch or No-Touch

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

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TriggerEvent() [1/2]

◆ TriggerEvent() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ Level

◆ MaturityDate

◆ TriggerDate

◆ TriggerDirection

◆ TriggerType