A representation of an un-built piece of complex market data, to allow for passing through to the vendor library for building. The market data will usually be in some standard form such as XML or Json, representing a curve or surface. More...
Public Member Functions | |
| OpaqueMarketData (string document=default(string), string format=default(string), string name=default(string), string lineage=default(string), MarketDataTypeEnum marketDataType=default(MarketDataTypeEnum)) | |
| Initializes a new instance of the OpaqueMarketData 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 (OpaqueMarketData input) |
| Returns true if OpaqueMarketData 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 | |
| OpaqueMarketData () | |
| Initializes a new instance of the OpaqueMarketData 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 | |
| string | Document [get, set] |
| The document as a string. More... | |
| string | Format [get, set] |
| What format is the document stored in, e.g. Xml. Supported string (enumeration) values are: [Unknown, Xml, Json, Csv]. More... | |
| string | Name [get, set] |
| Internal name of document. This is not used for search, it is simply a designator that helps identify the document and could be anything (filename, ftp address or similar) More... | |
| string | Lineage [get, set] |
| Description of the complex market data's lineage e.g. 'FundAccountant_GreenQuality'. 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
A representation of an un-built piece of complex market data, to allow for passing through to the vendor library for building. The market data will usually be in some standard form such as XML or Json, representing a curve or surface.
Constructor & Destructor Documentation
◆ OpaqueMarketData() [1/2]
|
inlineprotected |
Initializes a new instance of the OpaqueMarketData class.
◆ OpaqueMarketData() [2/2]
|
inline |
Initializes a new instance of the OpaqueMarketData class.
- Parameters
-
document The document as a string. (required). format What format is the document stored in, e.g. Xml. Supported string (enumeration) values are: [Unknown, Xml, Json, Csv]. (required). name Internal name of document. This is not used for search, it is simply a designator that helps identify the document and could be anything (filename, ftp address or similar) (required). lineage Description of the complex market data's lineage e.g. 'FundAccountant_GreenQuality'.. marketDataType The available values are: DiscountFactorCurveData, EquityVolSurfaceData, FxVolSurfaceData, IrVolCubeData, OpaqueMarketData, YieldCurveData, FxForwardCurveData, FxForwardPipsCurveData, FxForwardTenorCurveData, FxForwardTenorPipsCurveData, FxForwardCurveByQuoteReference, CreditSpreadCurveData, EquityCurveByPricesData, ConstantVolatilitySurface (required) (default to "OpaqueMarketData").
Member Function Documentation
◆ BaseValidate()
|
inlineprotected |
To validate all properties of the instance
- Parameters
-
validationContext Validation context
- Returns
- Validation Result
◆ Equals() [1/2]
|
inline |
Returns true if objects are equal
- Parameters
-
input Object to be compared
- Returns
- Boolean
◆ Equals() [2/2]
|
inline |
Returns true if OpaqueMarketData instances are equal
- Parameters
-
input Instance of OpaqueMarketData to be compared
- Returns
- Boolean
◆ GetHashCode()
|
inline |
Gets the hash code
- Returns
- Hash code
◆ ToJson()
|
inlinevirtual |
Returns the JSON string presentation of the object
- Returns
- JSON string presentation of the object
Reimplemented from Lusid.Sdk.Model.ComplexMarketData.
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ Document
|
getset |
The document as a string.
The document as a string.
◆ Format
|
getset |
What format is the document stored in, e.g. Xml. Supported string (enumeration) values are: [Unknown, Xml, Json, Csv].
What format is the document stored in, e.g. Xml. Supported string (enumeration) values are: [Unknown, Xml, Json, Csv].
◆ Lineage
|
getset |
Description of the complex market data's lineage e.g. 'FundAccountant_GreenQuality'.
Description of the complex market data's lineage e.g. 'FundAccountant_GreenQuality'.
◆ Name
|
getset |
Internal name of document. This is not used for search, it is simply a designator that helps identify the document and could be anything (filename, ftp address or similar)
Internal name of document. This is not used for search, it is simply a designator that helps identify the document and could be anything (filename, ftp address or similar)
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/OpaqueMarketData.cs
