LUSID C# SDK
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.InformationalEventAllOf Class Reference

InformationalEventAllOf More...

Inheritance diagram for Lusid.Sdk.Model.InformationalEventAllOf:
Inheritance graph
[legend]

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

Public Member Functions

 InformationalEventAllOf (DateTimeOffset anchorDate=default(DateTimeOffset), ResultValueDictionary diagnostics=default(ResultValueDictionary), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the InformationalEventAllOf 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...
 
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 (InformationalEventAllOf input)
 Returns true if InformationalEventAllOf instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 InformationalEventAllOf ()
 Initializes a new instance of the InformationalEventAllOf class. 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 More...
 
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...
 

Detailed Description

InformationalEventAllOf

Member Enumeration Documentation

◆ InstrumentEventTypeEnum

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

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

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

Constructor & Destructor Documentation

◆ InformationalEventAllOf() [1/2]

Lusid.Sdk.Model.InformationalEventAllOf.InformationalEventAllOf ( )
inlineprotected

Initializes a new instance of the InformationalEventAllOf class.

◆ InformationalEventAllOf() [2/2]

Lusid.Sdk.Model.InformationalEventAllOf.InformationalEventAllOf ( DateTimeOffset  anchorDate = default(DateTimeOffset),
ResultValueDictionary  diagnostics = default(ResultValueDictionary),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the InformationalEventAllOf class.

Parameters
anchorDateIn 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).
diagnosticsdiagnostics.
instrumentEventTypeThe 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).

Member Function Documentation

◆ Equals() [1/2]

bool Lusid.Sdk.Model.InformationalEventAllOf.Equals ( InformationalEventAllOf  input)
inline

Returns true if InformationalEventAllOf instances are equal

Parameters
inputInstance of InformationalEventAllOf to be compared
Returns
Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.InformationalEventAllOf.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.InformationalEventAllOf.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ShouldSerializeEventType()

bool Lusid.Sdk.Model.InformationalEventAllOf.ShouldSerializeEventType ( )
inline

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

Returns
false (boolean)

◆ ShouldSerializeEventWindowEnd()

bool Lusid.Sdk.Model.InformationalEventAllOf.ShouldSerializeEventWindowEnd ( )
inline

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

Returns
false (boolean)

◆ ToJson()

virtual string Lusid.Sdk.Model.InformationalEventAllOf.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.InformationalEventAllOf.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AnchorDate

DateTimeOffset Lusid.Sdk.Model.InformationalEventAllOf.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.

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.InformationalEventAllOf.Diagnostics
getset

Gets or Sets Diagnostics

◆ EventType

string Lusid.Sdk.Model.InformationalEventAllOf.EventType
get

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

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

◆ EventWindowEnd

DateTimeOffset Lusid.Sdk.Model.InformationalEventAllOf.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.

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.

◆ InstrumentEventType

InstrumentEventTypeEnum Lusid.Sdk.Model.InformationalEventAllOf.InstrumentEventType
getset

The documentation for this class was generated from the following file: