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

Model options for equity related pricing. More...

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

Public Member Functions

 EquityModelOptions (string equityForwardProjectionType=default(string), ModelOptionsTypeEnum modelOptionsType=default(ModelOptionsTypeEnum))
 Initializes a new instance of the EquityModelOptions 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 (EquityModelOptions input)
 Returns true if EquityModelOptions instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
- Public Member Functions inherited from Lusid.Sdk.Model.ModelOptions
 ModelOptions (ModelOptionsTypeEnum modelOptionsType=default(ModelOptionsTypeEnum))
 Initializes a new instance of the ModelOptions 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 (ModelOptions input)
 Returns true if ModelOptions instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string EquityForwardProjectionType [get, set]
 Determines how forward equity prices should be projected. Supported string (enumeration) values are: [FlatForwardCurveFromSpot, EquityCurveByPrices, ForwardProjectedFromRatesCurve]. More...
 
- Properties inherited from Lusid.Sdk.Model.ModelOptions
ModelOptionsTypeEnum ModelOptionsType [get, set]
 The available values are: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions More...
 

Additional Inherited Members

- Public Types inherited from Lusid.Sdk.Model.ModelOptions
enum class  ModelOptionsTypeEnum {
  Invalid = 1 , OpaqueModelOptions = 2 , EmptyModelOptions = 3 , IndexModelOptions = 4 ,
  FxForwardModelOptions = 5 , FundingLegModelOptions = 6 , EquityModelOptions = 7
}
 The available values are: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions More...
 

Detailed Description

Model options for equity related pricing.

Constructor & Destructor Documentation

◆ EquityModelOptions() [1/2]

Lusid.Sdk.Model.EquityModelOptions.EquityModelOptions ( )
inlineprotected

Initializes a new instance of the EquityModelOptions class.

◆ EquityModelOptions() [2/2]

Lusid.Sdk.Model.EquityModelOptions.EquityModelOptions ( string  equityForwardProjectionType = default(string),
ModelOptionsTypeEnum  modelOptionsType = default(ModelOptionsTypeEnum) 
)
inline

Initializes a new instance of the EquityModelOptions class.

Parameters
equityForwardProjectionTypeDetermines how forward equity prices should be projected. Supported string (enumeration) values are: [FlatForwardCurveFromSpot, EquityCurveByPrices, ForwardProjectedFromRatesCurve]. (required).
modelOptionsTypeThe available values are: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions (required) (default to "EquityModelOptions").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if EquityModelOptions instances are equal

Parameters
inputInstance of EquityModelOptions to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.ModelOptions.

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ EquityForwardProjectionType

string Lusid.Sdk.Model.EquityModelOptions.EquityForwardProjectionType
getset

Determines how forward equity prices should be projected. Supported string (enumeration) values are: [FlatForwardCurveFromSpot, EquityCurveByPrices, ForwardProjectedFromRatesCurve].

Determines how forward equity prices should be projected. Supported string (enumeration) values are: [FlatForwardCurveFromSpot, EquityCurveByPrices, ForwardProjectedFromRatesCurve].


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