Inheritance diagram for Lusid.Sdk.Model.FxForwardSettlementEventAllOf:

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
	FxForwardSettlementEventAllOf (DateTimeOffset maturityDate=default(DateTimeOffset), decimal domAmountPerUnit=default(decimal), string domCcy=default(string), decimal fgnAmountPerUnit=default(decimal), string fgnCcy=default(string), bool isNdf=default(bool), DateTimeOffset? fixingDate=default(DateTimeOffset?), string settlementCcy=default(string), decimal? cashFlowPerUnit=default(decimal?), decimal? domesticToForeignRate=default(decimal?), decimal? domesticToSettlementRate=default(decimal?), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the FxForwardSettlementEventAllOf class. 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 (FxForwardSettlementEventAllOf input)
	Returns true if FxForwardSettlementEventAllOf instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	FxForwardSettlementEventAllOf ()
	Initializes a new instance of the FxForwardSettlementEventAllOf 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...

DateTimeOffset	MaturityDate `[get, set]`
	Maturity date of the forward More...

decimal	DomAmountPerUnit `[get, set]`
	Amount per unit in the DomCcy (domestic currency) More...

string	DomCcy `[get, set]`
	The domestic currency of the forward More...

decimal	FgnAmountPerUnit `[get, set]`
	Amount per unit in the FgnCcy (foreign currency) More...

string	FgnCcy `[get, set]`
	The foreign currency of the forward. More...

bool	IsNdf `[get, set]`
	Is this settlement corresponding to a deliverable forward, or an NDF More...

DateTimeOffset?	FixingDate `[get, set]`
	Optional. Required if the event is an NDF (i.e. if IsNdf = true). Date of the FxRate fixings. More...

string	SettlementCcy `[get, set]`
	Optional. Required if the event is an NDF (i.e. if IsNdf = true). May be set to either DomCcy or FgnCcy, or a third currency. More...

decimal?	CashFlowPerUnit `[get, set]`
	Optional. Required if the event is an NDF (i.e. if IsNdf = true). CashFlow per unit. Paid in the SettlementCcy. More...

decimal?	DomesticToForeignRate `[get, set]`
	Domestic currency to foreign currency FX rate. Not required, only used to override quotes. More...

decimal?	DomesticToSettlementRate `[get, set]`
	Domestic currency to settlement currency FX rate Not required, only used to override quotes. More...

Detailed Description

FxForwardSettlementEventAllOf

Member Enumeration Documentation

◆ InstrumentEventTypeEnum

enum Lusid.Sdk.Model.FxForwardSettlementEventAllOf.InstrumentEventTypeEnum

strong

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

◆ FxForwardSettlementEventAllOf() [1/2]

Lusid.Sdk.Model.FxForwardSettlementEventAllOf.FxForwardSettlementEventAllOf ( )

inlineprotected

Initializes a new instance of the FxForwardSettlementEventAllOf class.

◆ FxForwardSettlementEventAllOf() [2/2]

Lusid.Sdk.Model.FxForwardSettlementEventAllOf.FxForwardSettlementEventAllOf	(	DateTimeOffset	maturityDate = `default(DateTimeOffset)`,
		decimal	domAmountPerUnit = `default(decimal)`,
		string	domCcy = `default(string)`,
		decimal	fgnAmountPerUnit = `default(decimal)`,
		string	fgnCcy = `default(string)`,
		bool	isNdf = `default(bool)`,
		DateTimeOffset?	fixingDate = `default(DateTimeOffset?)`,
		string	settlementCcy = `default(string)`,
		decimal?	cashFlowPerUnit = `default(decimal?)`,
		decimal?	domesticToForeignRate = `default(decimal?)`,
		decimal?	domesticToSettlementRate = `default(decimal?)`,
		InstrumentEventTypeEnum	instrumentEventType = `default(InstrumentEventTypeEnum)`
	)

inline

Initializes a new instance of the FxForwardSettlementEventAllOf class.

Parameters

maturityDate	Maturity date of the forward (required).
domAmountPerUnit	Amount per unit in the DomCcy (domestic currency) (required).
domCcy	The domestic currency of the forward (required).
fgnAmountPerUnit	Amount per unit in the FgnCcy (foreign currency) (required).
fgnCcy	The foreign currency of the forward. (required).
isNdf	Is this settlement corresponding to a deliverable forward, or an NDF (required).
fixingDate	Optional. Required if the event is an NDF (i.e. if IsNdf = true). Date of the FxRate fixings..
settlementCcy	Optional. Required if the event is an NDF (i.e. if IsNdf = true). May be set to either DomCcy or FgnCcy, or a third currency..
cashFlowPerUnit	Optional. Required if the event is an NDF (i.e. if IsNdf = true). CashFlow per unit. Paid in the SettlementCcy..
domesticToForeignRate	Domestic currency to foreign currency FX rate. Not required, only used to override quotes..
domesticToSettlementRate	Domestic currency to settlement currency FX rate Not required, only used to override quotes..
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).

Member Function Documentation

◆ Equals() [1/2]

bool Lusid.Sdk.Model.FxForwardSettlementEventAllOf.Equals ( FxForwardSettlementEventAllOf input )

inline

Returns true if FxForwardSettlementEventAllOf instances are equal

Parameters

input Instance of FxForwardSettlementEventAllOf to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.FxForwardSettlementEventAllOf.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.FxForwardSettlementEventAllOf.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ CashFlowPerUnit

decimal? Lusid.Sdk.Model.FxForwardSettlementEventAllOf.CashFlowPerUnit

getset

Optional. Required if the event is an NDF (i.e. if IsNdf = true). CashFlow per unit. Paid in the SettlementCcy.

◆ DomAmountPerUnit

decimal Lusid.Sdk.Model.FxForwardSettlementEventAllOf.DomAmountPerUnit

getset

Amount per unit in the DomCcy (domestic currency)

◆ DomCcy

string Lusid.Sdk.Model.FxForwardSettlementEventAllOf.DomCcy

getset

The domestic currency of the forward

◆ DomesticToForeignRate

decimal? Lusid.Sdk.Model.FxForwardSettlementEventAllOf.DomesticToForeignRate

getset

Domestic currency to foreign currency FX rate. Not required, only used to override quotes.

◆ DomesticToSettlementRate

decimal? Lusid.Sdk.Model.FxForwardSettlementEventAllOf.DomesticToSettlementRate

getset

Domestic currency to settlement currency FX rate Not required, only used to override quotes.

◆ FgnAmountPerUnit

decimal Lusid.Sdk.Model.FxForwardSettlementEventAllOf.FgnAmountPerUnit

getset

Amount per unit in the FgnCcy (foreign currency)

◆ FgnCcy

string Lusid.Sdk.Model.FxForwardSettlementEventAllOf.FgnCcy

getset

The foreign currency of the forward.

◆ FixingDate

DateTimeOffset? Lusid.Sdk.Model.FxForwardSettlementEventAllOf.FixingDate

getset

Optional. Required if the event is an NDF (i.e. if IsNdf = true). Date of the FxRate fixings.

◆ InstrumentEventType

InstrumentEventTypeEnum Lusid.Sdk.Model.FxForwardSettlementEventAllOf.InstrumentEventType

getset

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

◆ IsNdf

bool Lusid.Sdk.Model.FxForwardSettlementEventAllOf.IsNdf

getset

Is this settlement corresponding to a deliverable forward, or an NDF

◆ MaturityDate

DateTimeOffset Lusid.Sdk.Model.FxForwardSettlementEventAllOf.MaturityDate

getset

Maturity date of the forward

◆ SettlementCcy

string Lusid.Sdk.Model.FxForwardSettlementEventAllOf.SettlementCcy

getset

Optional. Required if the event is an NDF (i.e. if IsNdf = true). May be set to either DomCcy or FgnCcy, or a third currency.

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

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ InstrumentEventTypeEnum

Constructor & Destructor Documentation

◆ FxForwardSettlementEventAllOf() [1/2]

◆ FxForwardSettlementEventAllOf() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ CashFlowPerUnit

◆ DomAmountPerUnit

◆ DomCcy

◆ DomesticToForeignRate

◆ DomesticToSettlementRate

◆ FgnAmountPerUnit

◆ FgnCcy

◆ FixingDate

◆ InstrumentEventType

◆ IsNdf

◆ MaturityDate

◆ SettlementCcy