Base class for representing model options in LUSID, which provide config for instrument analytics. This base class should not be directly instantiated; each supported ModelOptionsType has a corresponding inherited class. More...

Inheritance diagram for Lusid.Sdk.Model.ModelOptions:

[legend]

Public Types
enum class	ModelOptionsTypeEnum { Invalid = 1 , OpaqueModelOptions = 2 , EmptyModelOptions = 3 , IndexModelOptions = 4 , FxForwardModelOptions = 5 , FundingLegModelOptions = 6 , EquityModelOptions = 7 , CdsModelOptions = 8 }
	Available values: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions, CdsModelOptions. More...

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

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

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

Protected Member Functions
	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
ModelOptionsTypeEnum	ModelOptionsType `[get, set]`
	Available values: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions, CdsModelOptions. More...

Detailed Description

Base class for representing model options in LUSID, which provide config for instrument analytics. This base class should not be directly instantiated; each supported ModelOptionsType has a corresponding inherited class.

Member Enumeration Documentation

◆ ModelOptionsTypeEnum

enum Lusid.Sdk.Model.ModelOptions.ModelOptionsTypeEnum

strong

Available values: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions, CdsModelOptions.

Enumerator
Invalid	Enum Invalid for value: Invalid
OpaqueModelOptions	Enum OpaqueModelOptions for value: OpaqueModelOptions
EmptyModelOptions	Enum EmptyModelOptions for value: EmptyModelOptions
IndexModelOptions	Enum IndexModelOptions for value: IndexModelOptions
FxForwardModelOptions	Enum FxForwardModelOptions for value: FxForwardModelOptions
FundingLegModelOptions	Enum FundingLegModelOptions for value: FundingLegModelOptions
EquityModelOptions	Enum EquityModelOptions for value: EquityModelOptions
CdsModelOptions	Enum CdsModelOptions for value: CdsModelOptions

Constructor & Destructor Documentation

◆ ModelOptions() [1/2]

Lusid.Sdk.Model.ModelOptions.ModelOptions ( )

inlineprotected

Initializes a new instance of the ModelOptions class.

◆ ModelOptions() [2/2]

Lusid.Sdk.Model.ModelOptions.ModelOptions ( ModelOptionsTypeEnum modelOptionsType = default(ModelOptionsTypeEnum) )

inline

Initializes a new instance of the ModelOptions class.

Parameters

modelOptionsType Available values: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions, CdsModelOptions. (required).

Member Function Documentation

◆ BaseValidate()

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

inline

Returns true if ModelOptions instances are equal

Parameters

input Instance of ModelOptions to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

Reimplemented in Lusid.Sdk.Model.OpaqueModelOptions, Lusid.Sdk.Model.IndexModelOptions, Lusid.Sdk.Model.FxForwardModelOptions, Lusid.Sdk.Model.FundingLegOptions, Lusid.Sdk.Model.EquityModelOptions, Lusid.Sdk.Model.EmptyModelOptions, and Lusid.Sdk.Model.CdsModelOptions.

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ ModelOptionsType

ModelOptionsTypeEnum Lusid.Sdk.Model.ModelOptions.ModelOptionsType

getset

Available values: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions, CdsModelOptions.

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

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ ModelOptionsTypeEnum

Constructor & Destructor Documentation

◆ ModelOptions() [1/2]

◆ ModelOptions() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ ModelOptionsType