A generic event derived from the economic definition of an instrument. This should be considered purely informational; any data provided by this event is not guaranteed to be processable by LUSID. More...

Inheritance diagram for Lusid.Sdk.Model.InformationalEvent:

[legend]

Public Member Functions
	InformationalEvent (DateTimeOffset anchorDate=default(DateTimeOffset), ResultValueDictionary diagnostics=default(ResultValueDictionary), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the InformationalEvent class. More...

bool	ShouldSerializeEventType ()
	Returns false as EventType should not be serialized given that it's read-only. 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 (InformationalEvent input)
	Returns true if InformationalEvent 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
	InformationalEvent ()
	Initializes a new instance of the InformationalEvent 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
string	EventType `[get]`
	What type of internal event does this represent; reset, exercise, amortisation etc. More...

DateTimeOffset	AnchorDate `[get, set]`
	In the case of a point event, the single date on which the event occurs. In the case of an event which is spread over a window, e.g. a barrier or American option, the start of that window. More...

DateTimeOffset	EventWindowEnd `[get]`
	In the case of a point event this is identical to the anchor date. In the case of an event that is spread over a window, this is the end of that window. More...

ResultValueDictionary	Diagnostics `[get, set]`
	Gets or Sets Diagnostics 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 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 }
	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 More...

Detailed Description

A generic event derived from the economic definition of an instrument. This should be considered purely informational; any data provided by this event is not guaranteed to be processable by LUSID.

Constructor & Destructor Documentation

◆ InformationalEvent() [1/2]

Lusid.Sdk.Model.InformationalEvent.InformationalEvent ( )

inlineprotected

Initializes a new instance of the InformationalEvent class.

◆ InformationalEvent() [2/2]

Lusid.Sdk.Model.InformationalEvent.InformationalEvent	(	DateTimeOffset	anchorDate = `default(DateTimeOffset)`,
		ResultValueDictionary	diagnostics = `default(ResultValueDictionary)`,
		InstrumentEventTypeEnum	instrumentEventType = `default(InstrumentEventTypeEnum)`
	)

inline

Initializes a new instance of the InformationalEvent class.

Parameters

anchorDate	In the case of a point event, the single date on which the event occurs. In the case of an event which is spread over a window, e.g. a barrier or American option, the start of that window. (required).
diagnostics	diagnostics.
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 (required) (default to "InformationalEvent").

Member Function Documentation

◆ BaseValidate()

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

inline

Returns true if InformationalEvent instances are equal

Parameters

input Instance of InformationalEvent to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ShouldSerializeEventType()

bool Lusid.Sdk.Model.InformationalEvent.ShouldSerializeEventType ( )

inline

Returns false as EventType should not be serialized given that it's read-only.

Returns: false (boolean)

◆ ShouldSerializeEventWindowEnd()

bool Lusid.Sdk.Model.InformationalEvent.ShouldSerializeEventWindowEnd ( )

inline

Returns false as EventWindowEnd should not be serialized given that it's read-only.

Returns: false (boolean)

◆ ToJson()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AnchorDate

DateTimeOffset Lusid.Sdk.Model.InformationalEvent.AnchorDate

getset

In the case of a point event, the single date on which the event occurs. In the case of an event which is spread over a window, e.g. a barrier or American option, the start of that window.

◆ Diagnostics

ResultValueDictionary Lusid.Sdk.Model.InformationalEvent.Diagnostics

getset

Gets or Sets Diagnostics

◆ EventType

string Lusid.Sdk.Model.InformationalEvent.EventType

get

What type of internal event does this represent; reset, exercise, amortisation etc.

◆ EventWindowEnd

DateTimeOffset Lusid.Sdk.Model.InformationalEvent.EventWindowEnd

get

In the case of a point event this is identical to the anchor date. In the case of an event that is spread over a window, this is the end of that window.

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

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InformationalEvent() [1/2]

◆ InformationalEvent() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ShouldSerializeEventType()

◆ ShouldSerializeEventWindowEnd()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AnchorDate

◆ Diagnostics

◆ EventType

◆ EventWindowEnd