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

IndexModelOptions More...

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

Public Types

enum class  PortfolioScalingEnum { Sum = 1 , AbsoluteSum = 2 , Unity = 3 }
 The available values are: Sum, AbsoluteSum, Unity More...
 
- 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...
 

Public Member Functions

 IndexModelOptions (PortfolioScalingEnum portfolioScaling=default(PortfolioScalingEnum), ModelOptionsTypeEnum modelOptionsType=default(ModelOptionsTypeEnum))
 Initializes a new instance of the IndexModelOptions 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 (IndexModelOptions input)
 Returns true if IndexModelOptions 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

 IndexModelOptions ()
 Initializes a new instance of the IndexModelOptions 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

PortfolioScalingEnum PortfolioScaling [get, set]
 The available values are: Sum, AbsoluteSum, Unity More...
 
- Properties inherited from Lusid.Sdk.Model.ModelOptions
ModelOptionsTypeEnum ModelOptionsType [get, set]
 The available values are: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions More...
 

Detailed Description

IndexModelOptions

Member Enumeration Documentation

◆ PortfolioScalingEnum

The available values are: Sum, AbsoluteSum, Unity

The available values are: Sum, AbsoluteSum, Unity

Enumerator
Sum 

Enum Sum for value: Sum

AbsoluteSum 

Enum AbsoluteSum for value: AbsoluteSum

Unity 

Enum Unity for value: Unity

Constructor & Destructor Documentation

◆ IndexModelOptions() [1/2]

Lusid.Sdk.Model.IndexModelOptions.IndexModelOptions ( )
inlineprotected

Initializes a new instance of the IndexModelOptions class.

◆ IndexModelOptions() [2/2]

Lusid.Sdk.Model.IndexModelOptions.IndexModelOptions ( PortfolioScalingEnum  portfolioScaling = default(PortfolioScalingEnum),
ModelOptionsTypeEnum  modelOptionsType = default(ModelOptionsTypeEnum) 
)
inline

Initializes a new instance of the IndexModelOptions class.

Parameters
portfolioScalingThe available values are: Sum, AbsoluteSum, Unity (required).
modelOptionsTypeThe available values are: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions (required) (default to "IndexModelOptions").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if IndexModelOptions instances are equal

Parameters
inputInstance of IndexModelOptions to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

override string Lusid.Sdk.Model.IndexModelOptions.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.IndexModelOptions.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ PortfolioScaling

PortfolioScalingEnum Lusid.Sdk.Model.IndexModelOptions.PortfolioScaling
getset

The available values are: Sum, AbsoluteSum, Unity

The available values are: Sum, AbsoluteSum, Unity


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