Settlement for FX Forward, including NDF and deliverable. More...

Inheritance diagram for Lusid.Sdk.Model.FxForwardSettlementEvent:

[legend]

Public Member Functions
	FxForwardSettlementEvent (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 FxForwardSettlementEvent 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 (FxForwardSettlementEvent input)
	Returns true if FxForwardSettlementEvent 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
	FxForwardSettlementEvent ()
	Initializes a new instance of the FxForwardSettlementEvent 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	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...

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...

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 }
	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

Settlement for FX Forward, including NDF and deliverable.

Constructor & Destructor Documentation

◆ FxForwardSettlementEvent() [1/2]

Lusid.Sdk.Model.FxForwardSettlementEvent.FxForwardSettlementEvent ( )

inlineprotected

Initializes a new instance of the FxForwardSettlementEvent class.

◆ FxForwardSettlementEvent() [2/2]

Lusid.Sdk.Model.FxForwardSettlementEvent.FxForwardSettlementEvent	(	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 FxForwardSettlementEvent 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) (default to "FxForwardSettlementEvent").

Member Function Documentation

◆ BaseValidate()

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

inline

Returns true if FxForwardSettlementEvent instances are equal

Parameters

input Instance of FxForwardSettlementEvent to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ CashFlowPerUnit

decimal? Lusid.Sdk.Model.FxForwardSettlementEvent.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.FxForwardSettlementEvent.DomAmountPerUnit

getset

Amount per unit in the DomCcy (domestic currency)

◆ DomCcy

string Lusid.Sdk.Model.FxForwardSettlementEvent.DomCcy

getset

The domestic currency of the forward

◆ DomesticToForeignRate

decimal? Lusid.Sdk.Model.FxForwardSettlementEvent.DomesticToForeignRate

getset

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

◆ DomesticToSettlementRate

decimal? Lusid.Sdk.Model.FxForwardSettlementEvent.DomesticToSettlementRate

getset

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

◆ FgnAmountPerUnit

decimal Lusid.Sdk.Model.FxForwardSettlementEvent.FgnAmountPerUnit

getset

Amount per unit in the FgnCcy (foreign currency)

◆ FgnCcy

string Lusid.Sdk.Model.FxForwardSettlementEvent.FgnCcy

getset

The foreign currency of the forward.

◆ FixingDate

DateTimeOffset? Lusid.Sdk.Model.FxForwardSettlementEvent.FixingDate

getset

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

◆ IsNdf

bool Lusid.Sdk.Model.FxForwardSettlementEvent.IsNdf

getset

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

◆ MaturityDate

DateTimeOffset Lusid.Sdk.Model.FxForwardSettlementEvent.MaturityDate

getset

Maturity date of the forward

◆ SettlementCcy

string Lusid.Sdk.Model.FxForwardSettlementEvent.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/FxForwardSettlementEvent.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxForwardSettlementEvent() [1/2]

◆ FxForwardSettlementEvent() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ CashFlowPerUnit

◆ DomAmountPerUnit

◆ DomCcy

◆ DomesticToForeignRate

◆ DomesticToSettlementRate

◆ FgnAmountPerUnit

◆ FgnCcy

◆ FixingDate

◆ IsNdf

◆ MaturityDate

◆ SettlementCcy