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

Contains data (i.e. dates and rates + metadata) for building fx forward curves More...

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

Public Member Functions

 FxForwardCurveData (DateTimeOffset baseDate=default(DateTimeOffset), string domCcy=default(string), string fgnCcy=default(string), List< DateTimeOffset > dates=default(List< DateTimeOffset >), List< decimal > rates=default(List< decimal >), string lineage=default(string), MarketDataOptions marketDataOptions=default(MarketDataOptions), MarketDataTypeEnum marketDataType=default(MarketDataTypeEnum))
 Initializes a new instance of the FxForwardCurveData 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 (FxForwardCurveData input)
 Returns true if FxForwardCurveData instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
- Public Member Functions inherited from Lusid.Sdk.Model.ComplexMarketData
 ComplexMarketData (MarketDataTypeEnum marketDataType=default(MarketDataTypeEnum))
 Initializes a new instance of the ComplexMarketData 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 (ComplexMarketData input)
 Returns true if ComplexMarketData instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 FxForwardCurveData ()
 Initializes a new instance of the FxForwardCurveData 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.ComplexMarketData
 ComplexMarketData ()
 Initializes a new instance of the ComplexMarketData class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 

Properties

DateTimeOffset BaseDate [get, set]
 EffectiveAt date of the quoted rates More...
 
string DomCcy [get, set]
 Domestic currency of the fx forward More...
 
string FgnCcy [get, set]
 Foreign currency of the fx forward More...
 
List< DateTimeOffset > Dates [get, set]
 Dates for which the forward rates apply More...
 
List< decimal > Rates [get, set]
 Rates provided for the fx forward (price in FgnCcy per unit of DomCcy) More...
 
string Lineage [get, set]
 Description of the complex market data&#39;s lineage e.g. &#39;FundAccountant_GreenQuality&#39;. More...
 
MarketDataOptions MarketDataOptions [get, set]
 Gets or Sets MarketDataOptions More...
 
- Properties inherited from Lusid.Sdk.Model.ComplexMarketData
MarketDataTypeEnum MarketDataType [get, set]
 The available values are: DiscountFactorCurveData, EquityVolSurfaceData, FxVolSurfaceData, IrVolCubeData, OpaqueMarketData, YieldCurveData, FxForwardCurveData, FxForwardPipsCurveData, FxForwardTenorCurveData, FxForwardTenorPipsCurveData, FxForwardCurveByQuoteReference, CreditSpreadCurveData, EquityCurveByPricesData, ConstantVolatilitySurface More...
 

Additional Inherited Members

- Public Types inherited from Lusid.Sdk.Model.ComplexMarketData
enum class  MarketDataTypeEnum {
  DiscountFactorCurveData = 1 , EquityVolSurfaceData = 2 , FxVolSurfaceData = 3 , IrVolCubeData = 4 ,
  OpaqueMarketData = 5 , YieldCurveData = 6 , FxForwardCurveData = 7 , FxForwardPipsCurveData = 8 ,
  FxForwardTenorCurveData = 9 , FxForwardTenorPipsCurveData = 10 , FxForwardCurveByQuoteReference = 11 , CreditSpreadCurveData = 12 ,
  EquityCurveByPricesData = 13 , ConstantVolatilitySurface = 14
}
 The available values are: DiscountFactorCurveData, EquityVolSurfaceData, FxVolSurfaceData, IrVolCubeData, OpaqueMarketData, YieldCurveData, FxForwardCurveData, FxForwardPipsCurveData, FxForwardTenorCurveData, FxForwardTenorPipsCurveData, FxForwardCurveByQuoteReference, CreditSpreadCurveData, EquityCurveByPricesData, ConstantVolatilitySurface More...
 

Detailed Description

Contains data (i.e. dates and rates + metadata) for building fx forward curves

Constructor & Destructor Documentation

◆ FxForwardCurveData() [1/2]

Lusid.Sdk.Model.FxForwardCurveData.FxForwardCurveData ( )
inlineprotected

Initializes a new instance of the FxForwardCurveData class.

◆ FxForwardCurveData() [2/2]

Lusid.Sdk.Model.FxForwardCurveData.FxForwardCurveData ( DateTimeOffset  baseDate = default(DateTimeOffset),
string  domCcy = default(string),
string  fgnCcy = default(string),
List< DateTimeOffset >  dates = default(List<DateTimeOffset>),
List< decimal >  rates = default(List<decimal>),
string  lineage = default(string),
MarketDataOptions  marketDataOptions = default(MarketDataOptions),
MarketDataTypeEnum  marketDataType = default(MarketDataTypeEnum) 
)
inline

Initializes a new instance of the FxForwardCurveData class.

Parameters
baseDateEffectiveAt date of the quoted rates (required).
domCcyDomestic currency of the fx forward (required).
fgnCcyForeign currency of the fx forward (required).
datesDates for which the forward rates apply (required).
ratesRates provided for the fx forward (price in FgnCcy per unit of DomCcy) (required).
lineageDescription of the complex market data&#39;s lineage e.g. &#39;FundAccountant_GreenQuality&#39;..
marketDataOptionsmarketDataOptions.
marketDataTypeThe available values are: DiscountFactorCurveData, EquityVolSurfaceData, FxVolSurfaceData, IrVolCubeData, OpaqueMarketData, YieldCurveData, FxForwardCurveData, FxForwardPipsCurveData, FxForwardTenorCurveData, FxForwardTenorPipsCurveData, FxForwardCurveByQuoteReference, CreditSpreadCurveData, EquityCurveByPricesData, ConstantVolatilitySurface (required) (default to "FxForwardCurveData").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if FxForwardCurveData instances are equal

Parameters
inputInstance of FxForwardCurveData to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

override string Lusid.Sdk.Model.FxForwardCurveData.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.ComplexMarketData.

◆ ToString()

override string Lusid.Sdk.Model.FxForwardCurveData.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ BaseDate

DateTimeOffset Lusid.Sdk.Model.FxForwardCurveData.BaseDate
getset

EffectiveAt date of the quoted rates

EffectiveAt date of the quoted rates

◆ Dates

List<DateTimeOffset> Lusid.Sdk.Model.FxForwardCurveData.Dates
getset

Dates for which the forward rates apply

Dates for which the forward rates apply

◆ DomCcy

string Lusid.Sdk.Model.FxForwardCurveData.DomCcy
getset

Domestic currency of the fx forward

Domestic currency of the fx forward

◆ FgnCcy

string Lusid.Sdk.Model.FxForwardCurveData.FgnCcy
getset

Foreign currency of the fx forward

Foreign currency of the fx forward

◆ Lineage

string Lusid.Sdk.Model.FxForwardCurveData.Lineage
getset

Description of the complex market data&#39;s lineage e.g. &#39;FundAccountant_GreenQuality&#39;.

Description of the complex market data&#39;s lineage e.g. &#39;FundAccountant_GreenQuality&#39;.

◆ MarketDataOptions

MarketDataOptions Lusid.Sdk.Model.FxForwardCurveData.MarketDataOptions
getset

Gets or Sets MarketDataOptions

◆ Rates

List<decimal> Lusid.Sdk.Model.FxForwardCurveData.Rates
getset

Rates provided for the fx forward (price in FgnCcy per unit of DomCcy)

Rates provided for the fx forward (price in FgnCcy per unit of DomCcy)


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