Event for cash option exercises. More...

Inheritance diagram for Lusid.Sdk.Model.OptionExerciseCashEvent:

[legend]

Public Member Functions
	OptionExerciseCashEvent (decimal? cashFlowPerUnit=default(decimal?), DateTimeOffset? exerciseDate=default(DateTimeOffset?), DateTimeOffset? deliveryDate=default(DateTimeOffset?), string exerciseType=default(string), DateTimeOffset maturityDate=default(DateTimeOffset), string moneyness=default(string), List< OptionExerciseElection > optionExerciseElections=default(List< OptionExerciseElection >), string optionType=default(string), DateTimeOffset startDate=default(DateTimeOffset), string strikeCurrency=default(string), decimal strikePerUnit=default(decimal), decimal? underlyingValuePerUnit=default(decimal?), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the OptionExerciseCashEvent 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 (OptionExerciseCashEvent input)
	Returns true if OptionExerciseCashEvent 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
	OptionExerciseCashEvent ()
	Initializes a new instance of the OptionExerciseCashEvent 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?	CashFlowPerUnit `[get, set]`
	The cashflow per unit More...

DateTimeOffset?	ExerciseDate `[get, set]`
	The exercise date of the option. More...

DateTimeOffset?	DeliveryDate `[get, set]`
	The delivery date of the option. More...

string	ExerciseType `[get, set]`
	The optionality type of the underlying option e.g. American, European. Supported string (enumeration) values are: [European, Bermudan, American]. More...

DateTimeOffset	MaturityDate `[get, set]`
	The maturity date of the option. More...

string	Moneyness `[get, set]`
	The moneyness of the option e.g. InTheMoney, OutOfTheMoney. Supported string (enumeration) values are: [InTheMoney, OutOfTheMoney, AtTheMoney]. More...

List< OptionExerciseElection >	OptionExerciseElections `[get, set]`
	Option exercise election for this OptionExercisePhysicalEvent. More...

string	OptionType `[get, set]`
	Type of optionality that is present e.g. call, put. Supported string (enumeration) values are: [Call, Put]. More...

DateTimeOffset	StartDate `[get, set]`
	The start date of the option. More...

string	StrikeCurrency `[get, set]`
	The strike currency of the equity option. More...

decimal	StrikePerUnit `[get, set]`
	The strike of the equity option times the number of shares to exchange if exercised. More...

decimal?	UnderlyingValuePerUnit `[get, set]`
	The underlying price times the number of shares to exchange if exercised. 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, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent 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 , SpinOffEvent = 27 , MergerEvent = 28 , FutureExpiryEvent = 29 , SwapCashFlowEvent = 30 , SwapPrincipalEvent = 31 , CreditPremiumCashFlowEvent = 32 , CdsCreditEvent = 33 , CdxCreditEvent = 34 , MbsCouponEvent = 35 , MbsPrincipalEvent = 36 , BonusIssueEvent = 37 , MbsPrincipalWriteOffEvent = 38 , MbsInterestDeferralEvent = 39 , MbsInterestShortfallEvent = 40 , TenderEvent = 41 , CallOnIntermediateSecuritiesEvent = 42 , IntermediateSecuritiesDistributionEvent = 43 , OptionExercisePhysicalEvent = 44 , OptionExerciseCashEvent = 45 , ProtectionPayoutCashFlowEvent = 46 , TermDepositInterestEvent = 47 , TermDepositPrincipalEvent = 48 , EarlyRedemptionEvent = 49 , FutureMarkToMarketEvent = 50 , AdjustGlobalCommitmentEvent = 51 , ContractInitialisationEvent = 52 , DrawdownEvent = 53 , LoanInterestRepaymentEvent = 54 }
	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, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent More...

Detailed Description

Event for cash option exercises.

Constructor & Destructor Documentation

◆ OptionExerciseCashEvent() [1/2]

Lusid.Sdk.Model.OptionExerciseCashEvent.OptionExerciseCashEvent ( )

inlineprotected

Initializes a new instance of the OptionExerciseCashEvent class.

◆ OptionExerciseCashEvent() [2/2]

Lusid.Sdk.Model.OptionExerciseCashEvent.OptionExerciseCashEvent	(	decimal?	cashFlowPerUnit = `default(decimal?)`,
		DateTimeOffset?	exerciseDate = `default(DateTimeOffset?)`,
		DateTimeOffset?	deliveryDate = `default(DateTimeOffset?)`,
		string	exerciseType = `default(string)`,
		DateTimeOffset	maturityDate = `default(DateTimeOffset)`,
		string	moneyness = `default(string)`,
		List< OptionExerciseElection >	optionExerciseElections = `default(List<OptionExerciseElection>)`,
		string	optionType = `default(string)`,
		DateTimeOffset	startDate = `default(DateTimeOffset)`,
		string	strikeCurrency = `default(string)`,
		decimal	strikePerUnit = `default(decimal)`,
		decimal?	underlyingValuePerUnit = `default(decimal?)`,
		InstrumentEventTypeEnum	instrumentEventType = `default(InstrumentEventTypeEnum)`
	)

inline

Initializes a new instance of the OptionExerciseCashEvent class.

Parameters

cashFlowPerUnit	The cashflow per unit.
exerciseDate	The exercise date of the option..
deliveryDate	The delivery date of the option..
exerciseType	The optionality type of the underlying option e.g. American, European. Supported string (enumeration) values are: [European, Bermudan, American]. (required).
maturityDate	The maturity date of the option. (required).
moneyness	The moneyness of the option e.g. InTheMoney, OutOfTheMoney. Supported string (enumeration) values are: [InTheMoney, OutOfTheMoney, AtTheMoney]..
optionExerciseElections	Option exercise election for this OptionExercisePhysicalEvent..
optionType	Type of optionality that is present e.g. call, put. Supported string (enumeration) values are: [Call, Put]. (required).
startDate	The start date of the option. (required).
strikeCurrency	The strike currency of the equity option. (required).
strikePerUnit	The strike of the equity option times the number of shares to exchange if exercised. (required).
underlyingValuePerUnit	The underlying price times the number of shares to exchange if exercised..
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, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent (required) (default to "OptionExerciseCashEvent").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.OptionExerciseCashEvent.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.OptionExerciseCashEvent.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.OptionExerciseCashEvent.Equals ( OptionExerciseCashEvent input )

inline

Returns true if OptionExerciseCashEvent instances are equal

Parameters

input Instance of OptionExerciseCashEvent to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ CashFlowPerUnit

decimal? Lusid.Sdk.Model.OptionExerciseCashEvent.CashFlowPerUnit

getset

The cashflow per unit

◆ DeliveryDate

DateTimeOffset? Lusid.Sdk.Model.OptionExerciseCashEvent.DeliveryDate

getset

The delivery date of the option.

◆ ExerciseDate

DateTimeOffset? Lusid.Sdk.Model.OptionExerciseCashEvent.ExerciseDate

getset

The exercise date of the option.

◆ ExerciseType

string Lusid.Sdk.Model.OptionExerciseCashEvent.ExerciseType

getset

The optionality type of the underlying option e.g. American, European. Supported string (enumeration) values are: [European, Bermudan, American].

◆ MaturityDate

DateTimeOffset Lusid.Sdk.Model.OptionExerciseCashEvent.MaturityDate

getset

The maturity date of the option.

◆ Moneyness

string Lusid.Sdk.Model.OptionExerciseCashEvent.Moneyness

getset

The moneyness of the option e.g. InTheMoney, OutOfTheMoney. Supported string (enumeration) values are: [InTheMoney, OutOfTheMoney, AtTheMoney].

◆ OptionExerciseElections

List<OptionExerciseElection> Lusid.Sdk.Model.OptionExerciseCashEvent.OptionExerciseElections

getset

Option exercise election for this OptionExercisePhysicalEvent.

◆ OptionType

string Lusid.Sdk.Model.OptionExerciseCashEvent.OptionType

getset

Type of optionality that is present e.g. call, put. Supported string (enumeration) values are: [Call, Put].

◆ StartDate

DateTimeOffset Lusid.Sdk.Model.OptionExerciseCashEvent.StartDate

getset

The start date of the option.

◆ StrikeCurrency

string Lusid.Sdk.Model.OptionExerciseCashEvent.StrikeCurrency

getset

The strike currency of the equity option.

◆ StrikePerUnit

decimal Lusid.Sdk.Model.OptionExerciseCashEvent.StrikePerUnit

getset

The strike of the equity option times the number of shares to exchange if exercised.

◆ UnderlyingValuePerUnit

decimal? Lusid.Sdk.Model.OptionExerciseCashEvent.UnderlyingValuePerUnit

getset

The underlying price times the number of shares to exchange if exercised.

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/OptionExerciseCashEvent.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OptionExerciseCashEvent() [1/2]

◆ OptionExerciseCashEvent() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ CashFlowPerUnit

◆ DeliveryDate

◆ ExerciseDate

◆ ExerciseType

◆ MaturityDate

◆ Moneyness

◆ OptionExerciseElections

◆ OptionType

◆ StartDate

◆ StrikeCurrency

◆ StrikePerUnit

◆ UnderlyingValuePerUnit