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

The termination of an instrument. In some cases termination can happen over a range of dates e.g. american option exercise. In most cases the startDate == endDate More...

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

Public Member Functions

 CloseEvent (DateTimeOffset startDate=default(DateTimeOffset), DateTimeOffset endDate=default(DateTimeOffset), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the CloseEvent 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 (CloseEvent input)
 Returns true if CloseEvent 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

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

DateTimeOffset StartDate [get, set]
 The first date on which the instrument could close More...
 
DateTimeOffset EndDate [get, set]
 The last date on which the instrument could close 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

The termination of an instrument. In some cases termination can happen over a range of dates e.g. american option exercise. In most cases the startDate &#x3D;&#x3D; endDate

Constructor & Destructor Documentation

◆ CloseEvent() [1/2]

Lusid.Sdk.Model.CloseEvent.CloseEvent ( )
inlineprotected

Initializes a new instance of the CloseEvent class.

◆ CloseEvent() [2/2]

Lusid.Sdk.Model.CloseEvent.CloseEvent ( DateTimeOffset  startDate = default(DateTimeOffset),
DateTimeOffset  endDate = default(DateTimeOffset),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the CloseEvent class.

Parameters
startDateThe first date on which the instrument could close.
endDateThe last date on which the instrument could close.
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 "CloseEvent").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if CloseEvent instances are equal

Parameters
inputInstance of CloseEvent to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ EndDate

DateTimeOffset Lusid.Sdk.Model.CloseEvent.EndDate
getset

The last date on which the instrument could close

The last date on which the instrument could close

◆ StartDate

DateTimeOffset Lusid.Sdk.Model.CloseEvent.StartDate
getset

The first date on which the instrument could close

The first date on which the instrument could close


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