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...
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 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]
|
inlineprotected |
Initializes a new instance of the InformationalEvent class.
◆ InformationalEvent() [2/2]
|
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 (required) (default to "InformationalEvent").
Member Function Documentation
◆ BaseValidate()
|
inlineprotected |
To validate all properties of the instance
- Parameters
-
validationContext Validation context
- Returns
- Validation Result
◆ Equals() [1/2]
|
inline |
Returns true if InformationalEvent instances are equal
- Parameters
-
input Instance of InformationalEvent to be compared
- Returns
- Boolean
◆ Equals() [2/2]
|
inline |
Returns true if objects are equal
- Parameters
-
input Object to be compared
- Returns
- Boolean
◆ GetHashCode()
|
inline |
Gets the hash code
- Returns
- Hash code
◆ ShouldSerializeEventType()
|
inline |
Returns false as EventType should not be serialized given that it's read-only.
- Returns
- false (boolean)
◆ ShouldSerializeEventWindowEnd()
|
inline |
Returns false as EventWindowEnd should not be serialized given that it's read-only.
- Returns
- false (boolean)
◆ ToJson()
|
inlinevirtual |
Returns the JSON string presentation of the object
- Returns
- JSON string presentation of the object
Reimplemented from Lusid.Sdk.Model.InstrumentEvent.
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ 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
|
getset |
Gets or Sets Diagnostics
◆ 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
|
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.
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
