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

Definition of an exercise event. This is an event that occurs on transformation of an instrument owing to exercise. e.g. an option of some type into its underlying. More...

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

Public Member Functions

 ExerciseEvent (LusidInstrument instrument=default(LusidInstrument), DateTimeOffset anchorDate=default(DateTimeOffset), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the ExerciseEvent class. 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 (ExerciseEvent input)
 Returns true if ExerciseEvent 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

 ExerciseEvent ()
 Initializes a new instance of the ExerciseEvent 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

LusidInstrument Instrument [get, set]
 Gets or Sets Instrument More...
 
DateTimeOffset AnchorDate [get, set]
 The date the exercise window starts, or point it takes effect on. More...
 
DateTimeOffset EventWindowEnd [get]
 The date the exercise window ends, or point it takes effect on. 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 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
}
 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 More...
 

Detailed Description

Definition of an exercise event. This is an event that occurs on transformation of an instrument owing to exercise. e.g. an option of some type into its underlying.

Constructor & Destructor Documentation

◆ ExerciseEvent() [1/2]

Lusid.Sdk.Model.ExerciseEvent.ExerciseEvent ( )
inlineprotected

Initializes a new instance of the ExerciseEvent class.

◆ ExerciseEvent() [2/2]

Lusid.Sdk.Model.ExerciseEvent.ExerciseEvent ( LusidInstrument  instrument = default(LusidInstrument),
DateTimeOffset  anchorDate = default(DateTimeOffset),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the ExerciseEvent class.

Parameters
instrumentinstrument (required).
anchorDateThe date the exercise window starts, or point it takes effect on. (required).
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, CapitalDistributionEvent (required) (default to "ExerciseEvent").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if ExerciseEvent instances are equal

Parameters
inputInstance of ExerciseEvent to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ShouldSerializeEventWindowEnd()

bool Lusid.Sdk.Model.ExerciseEvent.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.ExerciseEvent.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.ExerciseEvent.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AnchorDate

DateTimeOffset Lusid.Sdk.Model.ExerciseEvent.AnchorDate
getset

The date the exercise window starts, or point it takes effect on.

The date the exercise window starts, or point it takes effect on.

◆ EventWindowEnd

DateTimeOffset Lusid.Sdk.Model.ExerciseEvent.EventWindowEnd
get

The date the exercise window ends, or point it takes effect on.

The date the exercise window ends, or point it takes effect on.

◆ Instrument

LusidInstrument Lusid.Sdk.Model.ExerciseEvent.Instrument
getset

Gets or Sets Instrument


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