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

Economic dependency required to price Equity derivative products that contain optionality. Equity Vol surface is a grid of implied volatilities for an array of strikes and tenors, derived from vanilla option prices in the market. More...

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

Public Member Functions

 EquityVolDependency (string code=default(string), string domesticCurrency=default(string), string volType=default(string), DateTimeOffset date=default(DateTimeOffset), DependencyTypeEnum dependencyType=default(DependencyTypeEnum))
 Initializes a new instance of the EquityVolDependency 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 (EquityVolDependency input)
 Returns true if EquityVolDependency instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
- Public Member Functions inherited from Lusid.Sdk.Model.EconomicDependency
 EconomicDependency (DependencyTypeEnum dependencyType=default(DependencyTypeEnum))
 Initializes a new instance of the EconomicDependency 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 (EconomicDependency input)
 Returns true if EconomicDependency instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string Code [get, set]
 The code identifying the corresponding equity, e.g. US0378331005 if the MarketIdentifier was set to ISIN More...
 
string DomesticCurrency [get, set]
 The domestic currency of the instrument declaring this dependency. More...
 
string VolType [get, set]
 Volatility type e.g. &quot;LN&quot; and &quot;N&quot; for log-normal and normal volatility. More...
 
DateTimeOffset Date [get, set]
 The effectiveDate of the entity that this is a dependency for. Unless there is an obvious date this should be, like for a historic reset, then this is the valuation date. More...
 
- Properties inherited from Lusid.Sdk.Model.EconomicDependency
DependencyTypeEnum DependencyType [get, set]
 The available values are: OpaqueDependency, CashDependency, DiscountingDependency, EquityCurveDependency, EquityVolDependency, FxDependency, FxForwardsDependency, FxVolDependency, IndexProjectionDependency, IrVolDependency, QuoteDependency, Vendor, CalendarDependency, InflationFixingDependency More...
 

Additional Inherited Members

- Public Types inherited from Lusid.Sdk.Model.EconomicDependency
enum class  DependencyTypeEnum {
  OpaqueDependency = 1 , CashDependency = 2 , DiscountingDependency = 3 , EquityCurveDependency = 4 ,
  EquityVolDependency = 5 , FxDependency = 6 , FxForwardsDependency = 7 , FxVolDependency = 8 ,
  IndexProjectionDependency = 9 , IrVolDependency = 10 , QuoteDependency = 11 , Vendor = 12 ,
  CalendarDependency = 13 , InflationFixingDependency = 14
}
 The available values are: OpaqueDependency, CashDependency, DiscountingDependency, EquityCurveDependency, EquityVolDependency, FxDependency, FxForwardsDependency, FxVolDependency, IndexProjectionDependency, IrVolDependency, QuoteDependency, Vendor, CalendarDependency, InflationFixingDependency More...
 

Detailed Description

Economic dependency required to price Equity derivative products that contain optionality. Equity Vol surface is a grid of implied volatilities for an array of strikes and tenors, derived from vanilla option prices in the market.

Constructor & Destructor Documentation

◆ EquityVolDependency() [1/2]

Lusid.Sdk.Model.EquityVolDependency.EquityVolDependency ( )
inlineprotected

Initializes a new instance of the EquityVolDependency class.

◆ EquityVolDependency() [2/2]

Lusid.Sdk.Model.EquityVolDependency.EquityVolDependency ( string  code = default(string),
string  domesticCurrency = default(string),
string  volType = default(string),
DateTimeOffset  date = default(DateTimeOffset),
DependencyTypeEnum  dependencyType = default(DependencyTypeEnum) 
)
inline

Initializes a new instance of the EquityVolDependency class.

Parameters
codeThe code identifying the corresponding equity, e.g. US0378331005 if the MarketIdentifier was set to ISIN (required).
domesticCurrencyThe domestic currency of the instrument declaring this dependency. (required).
volTypeVolatility type e.g. &quot;LN&quot; and &quot;N&quot; for log-normal and normal volatility. (required).
dateThe effectiveDate of the entity that this is a dependency for. Unless there is an obvious date this should be, like for a historic reset, then this is the valuation date. (required).
dependencyTypeThe available values are: OpaqueDependency, CashDependency, DiscountingDependency, EquityCurveDependency, EquityVolDependency, FxDependency, FxForwardsDependency, FxVolDependency, IndexProjectionDependency, IrVolDependency, QuoteDependency, Vendor, CalendarDependency, InflationFixingDependency (required) (default to "EquityVolDependency").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if EquityVolDependency instances are equal

Parameters
inputInstance of EquityVolDependency to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.EconomicDependency.

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Code

string Lusid.Sdk.Model.EquityVolDependency.Code
getset

The code identifying the corresponding equity, e.g. US0378331005 if the MarketIdentifier was set to ISIN

The code identifying the corresponding equity, e.g. US0378331005 if the MarketIdentifier was set to ISIN

◆ Date

DateTimeOffset Lusid.Sdk.Model.EquityVolDependency.Date
getset

The effectiveDate of the entity that this is a dependency for. Unless there is an obvious date this should be, like for a historic reset, then this is the valuation date.

The effectiveDate of the entity that this is a dependency for. Unless there is an obvious date this should be, like for a historic reset, then this is the valuation date.

◆ DomesticCurrency

string Lusid.Sdk.Model.EquityVolDependency.DomesticCurrency
getset

The domestic currency of the instrument declaring this dependency.

The domestic currency of the instrument declaring this dependency.

◆ VolType

string Lusid.Sdk.Model.EquityVolDependency.VolType
getset

Volatility type e.g. &quot;LN&quot; and &quot;N&quot; for log-normal and normal volatility.

Volatility type e.g. &quot;LN&quot; and &quot;N&quot; for log-normal and normal volatility.


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