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

Inherits IEquatable< InstrumentEvent >, and IValidatableObject.

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

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

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

enum Lusid.Sdk.Model.InstrumentEvent.InstrumentEventTypeEnum

strong

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

Enumerator
TransitionEvent	Enum TransitionEvent for value: TransitionEvent
InformationalEvent	Enum InformationalEvent for value: InformationalEvent
OpenEvent	Enum OpenEvent for value: 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
CapitalDistributionEvent	Enum CapitalDistributionEvent for value: CapitalDistributionEvent
SpinOffEvent	Enum SpinOffEvent for value: SpinOffEvent
MergerEvent	Enum MergerEvent for value: MergerEvent
FutureExpiryEvent	Enum FutureExpiryEvent for value: FutureExpiryEvent
SwapCashFlowEvent	Enum SwapCashFlowEvent for value: SwapCashFlowEvent
SwapPrincipalEvent	Enum SwapPrincipalEvent for value: SwapPrincipalEvent
CreditPremiumCashFlowEvent	Enum CreditPremiumCashFlowEvent for value: CreditPremiumCashFlowEvent
CdsCreditEvent	Enum CdsCreditEvent for value: CdsCreditEvent
CdxCreditEvent	Enum CdxCreditEvent for value: CdxCreditEvent
MbsCouponEvent	Enum MbsCouponEvent for value: MbsCouponEvent
MbsPrincipalEvent	Enum MbsPrincipalEvent for value: MbsPrincipalEvent
BonusIssueEvent	Enum BonusIssueEvent for value: BonusIssueEvent
MbsPrincipalWriteOffEvent	Enum MbsPrincipalWriteOffEvent for value: MbsPrincipalWriteOffEvent
MbsInterestDeferralEvent	Enum MbsInterestDeferralEvent for value: MbsInterestDeferralEvent
MbsInterestShortfallEvent	Enum MbsInterestShortfallEvent for value: MbsInterestShortfallEvent
TenderEvent	Enum TenderEvent for value: TenderEvent
CallOnIntermediateSecuritiesEvent	Enum CallOnIntermediateSecuritiesEvent for value: CallOnIntermediateSecuritiesEvent
IntermediateSecuritiesDistributionEvent	Enum IntermediateSecuritiesDistributionEvent for value: IntermediateSecuritiesDistributionEvent
OptionExercisePhysicalEvent	Enum OptionExercisePhysicalEvent for value: OptionExercisePhysicalEvent
OptionExerciseCashEvent	Enum OptionExerciseCashEvent for value: OptionExerciseCashEvent
ProtectionPayoutCashFlowEvent	Enum ProtectionPayoutCashFlowEvent for value: ProtectionPayoutCashFlowEvent
TermDepositInterestEvent	Enum TermDepositInterestEvent for value: TermDepositInterestEvent
TermDepositPrincipalEvent	Enum TermDepositPrincipalEvent for value: TermDepositPrincipalEvent
EarlyRedemptionEvent	Enum EarlyRedemptionEvent for value: EarlyRedemptionEvent
FutureMarkToMarketEvent	Enum FutureMarkToMarketEvent for value: FutureMarkToMarketEvent
AdjustGlobalCommitmentEvent	Enum AdjustGlobalCommitmentEvent for value: AdjustGlobalCommitmentEvent
ContractInitialisationEvent	Enum ContractInitialisationEvent for value: ContractInitialisationEvent
DrawdownEvent	Enum DrawdownEvent for value: DrawdownEvent
LoanInterestRepaymentEvent	Enum LoanInterestRepaymentEvent for value: LoanInterestRepaymentEvent

Constructor & Destructor Documentation

◆ InstrumentEvent() [1/2]

Lusid.Sdk.Model.InstrumentEvent.InstrumentEvent ( )

inlineprotected

Initializes a new instance of the InstrumentEvent class.

◆ InstrumentEvent() [2/2]

Lusid.Sdk.Model.InstrumentEvent.InstrumentEvent ( InstrumentEventTypeEnum instrumentEventType = default(InstrumentEventTypeEnum) )

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

Member Function Documentation

◆ BaseValidate()

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

inlineprotected

To validate all properties of the instance

Parameters

validationContext Validation context

Returns: Validation Result

◆ Equals() [1/2]

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

inline

Returns true if InstrumentEvent instances are equal

Parameters

input Instance of InstrumentEvent to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.InstrumentEvent.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.InstrumentEvent.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ InstrumentEventType

InstrumentEventTypeEnum Lusid.Sdk.Model.InstrumentEvent.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, 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

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

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ InstrumentEventTypeEnum

Constructor & Destructor Documentation

◆ InstrumentEvent() [1/2]

◆ InstrumentEvent() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ InstrumentEventType