Definition of a CashFlow event. This is an event that describes the occurence of a cashflow and associated information. More...

Inheritance diagram for Lusid.Sdk.Model.CashFlowEvent:

[legend]

Public Member Functions
	CashFlowEvent (CashFlowValue cashFlowValue=default(CashFlowValue), string eventStatus=default(string), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the CashFlowEvent class. More...

bool	ShouldSerializeEventType ()
	Returns false as EventType 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 (CashFlowEvent input)
	Returns true if CashFlowEvent 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
	CashFlowEvent ()
	Initializes a new instance of the CashFlowEvent 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
CashFlowValue	CashFlowValue `[get, set]`
	Gets or Sets CashFlowValue More...

string	EventType `[get]`
	What type of internal event does this represent; coupon, principal, premium etc. More...

string	EventStatus `[get, set]`
	What is the event status, is it a known (ie historic) or unknown (ie projected) event? 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 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 }
	The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent More...

Detailed Description

Definition of a CashFlow event. This is an event that describes the occurence of a cashflow and associated information.

Constructor & Destructor Documentation

◆ CashFlowEvent() [1/2]

Lusid.Sdk.Model.CashFlowEvent.CashFlowEvent ( )

inlineprotected

Initializes a new instance of the CashFlowEvent class.

◆ CashFlowEvent() [2/2]

Lusid.Sdk.Model.CashFlowEvent.CashFlowEvent	(	CashFlowValue	cashFlowValue = `default(CashFlowValue)`,
		string	eventStatus = `default(string)`,
		InstrumentEventTypeEnum	instrumentEventType = `default(InstrumentEventTypeEnum)`
	)

inline

Initializes a new instance of the CashFlowEvent class.

Parameters

cashFlowValue	cashFlowValue (required).
eventStatus	What is the event status, is it a known (ie historic) or unknown (ie projected) event? (required).
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 (required) (default to "CashFlowEvent").

Member Function Documentation

◆ BaseValidate()

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

inline

Returns true if CashFlowEvent instances are equal

Parameters

input Instance of CashFlowEvent to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ShouldSerializeEventType()

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

inline

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

Returns: false (boolean)

◆ ToJson()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ CashFlowValue

CashFlowValue Lusid.Sdk.Model.CashFlowEvent.CashFlowValue

getset

Gets or Sets CashFlowValue

◆ EventStatus

string Lusid.Sdk.Model.CashFlowEvent.EventStatus

getset

What is the event status, is it a known (ie historic) or unknown (ie projected) event?

◆ EventType

string Lusid.Sdk.Model.CashFlowEvent.EventType

get

What type of internal event does this represent; coupon, principal, premium etc.

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

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CashFlowEvent() [1/2]

◆ CashFlowEvent() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ShouldSerializeEventType()

◆ ToJson()

◆ ToString()

Property Documentation

◆ CashFlowValue

◆ EventStatus

◆ EventType