Base class for representing complex market data in LUSID. Generally speaking, market data is complex when it cannot be represented as a single quote. Examples include discounting curves, projection curves, and volatility surfaces, which are used to compute instrument analytics. This base class should not be directly instantiated; each supported MarketDataType has a corresponding inherited class. More...

Inheritance diagram for Lusid.Sdk.Model.ComplexMarketData:

[legend]

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

Public Member Functions
	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...

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 (ComplexMarketData input)
	Returns true if ComplexMarketData instances are equal More...

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

Protected Member Functions
	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
MarketDataTypeEnum	MarketDataType `[get, set]`
	The available values are: DiscountFactorCurveData, EquityVolSurfaceData, FxVolSurfaceData, IrVolCubeData, OpaqueMarketData, YieldCurveData, FxForwardCurveData, FxForwardPipsCurveData, FxForwardTenorCurveData, FxForwardTenorPipsCurveData, FxForwardCurveByQuoteReference, CreditSpreadCurveData, EquityCurveByPricesData, ConstantVolatilitySurface More...

Detailed Description

Base class for representing complex market data in LUSID. Generally speaking, market data is complex when it cannot be represented as a single quote. Examples include discounting curves, projection curves, and volatility surfaces, which are used to compute instrument analytics. This base class should not be directly instantiated; each supported MarketDataType has a corresponding inherited class.

Member Enumeration Documentation

◆ MarketDataTypeEnum

enum Lusid.Sdk.Model.ComplexMarketData.MarketDataTypeEnum

strong

The available values are: DiscountFactorCurveData, EquityVolSurfaceData, FxVolSurfaceData, IrVolCubeData, OpaqueMarketData, YieldCurveData, FxForwardCurveData, FxForwardPipsCurveData, FxForwardTenorCurveData, FxForwardTenorPipsCurveData, FxForwardCurveByQuoteReference, CreditSpreadCurveData, EquityCurveByPricesData, ConstantVolatilitySurface

Enumerator
DiscountFactorCurveData	Enum DiscountFactorCurveData for value: DiscountFactorCurveData
EquityVolSurfaceData	Enum EquityVolSurfaceData for value: EquityVolSurfaceData
FxVolSurfaceData	Enum FxVolSurfaceData for value: FxVolSurfaceData
IrVolCubeData	Enum IrVolCubeData for value: IrVolCubeData
OpaqueMarketData	Enum OpaqueMarketData for value: OpaqueMarketData
YieldCurveData	Enum YieldCurveData for value: YieldCurveData
FxForwardCurveData	Enum FxForwardCurveData for value: FxForwardCurveData
FxForwardPipsCurveData	Enum FxForwardPipsCurveData for value: FxForwardPipsCurveData
FxForwardTenorCurveData	Enum FxForwardTenorCurveData for value: FxForwardTenorCurveData
FxForwardTenorPipsCurveData	Enum FxForwardTenorPipsCurveData for value: FxForwardTenorPipsCurveData
FxForwardCurveByQuoteReference	Enum FxForwardCurveByQuoteReference for value: FxForwardCurveByQuoteReference
CreditSpreadCurveData	Enum CreditSpreadCurveData for value: CreditSpreadCurveData
EquityCurveByPricesData	Enum EquityCurveByPricesData for value: EquityCurveByPricesData
ConstantVolatilitySurface	Enum ConstantVolatilitySurface for value: ConstantVolatilitySurface

Constructor & Destructor Documentation

◆ ComplexMarketData() [1/2]

Lusid.Sdk.Model.ComplexMarketData.ComplexMarketData ( )

inlineprotected

Initializes a new instance of the ComplexMarketData class.

◆ ComplexMarketData() [2/2]

Lusid.Sdk.Model.ComplexMarketData.ComplexMarketData ( MarketDataTypeEnum marketDataType = default(MarketDataTypeEnum) )

inline

Initializes a new instance of the ComplexMarketData class.

Parameters

marketDataType The available values are: DiscountFactorCurveData, EquityVolSurfaceData, FxVolSurfaceData, IrVolCubeData, OpaqueMarketData, YieldCurveData, FxForwardCurveData, FxForwardPipsCurveData, FxForwardTenorCurveData, FxForwardTenorPipsCurveData, FxForwardCurveByQuoteReference, CreditSpreadCurveData, EquityCurveByPricesData, ConstantVolatilitySurface (required).

Member Function Documentation

◆ BaseValidate()

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

inline

Returns true if ComplexMarketData instances are equal

Parameters

input Instance of ComplexMarketData to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ MarketDataType

MarketDataTypeEnum Lusid.Sdk.Model.ComplexMarketData.MarketDataType

getset

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

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ MarketDataTypeEnum

Constructor & Destructor Documentation

◆ ComplexMarketData() [1/2]

◆ ComplexMarketData() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ MarketDataType