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

FxForwardModelOptionsAllOf More...

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

Public Types

enum class  ForwardRateObservableTypeEnum {
  ForwardPoints = 1 , ForwardRate = 2 , RatesCurve = 3 , FxForwardCurve = 4 ,
  Invalid = 5
}
 The available values are: ForwardPoints, ForwardRate, RatesCurve, FxForwardCurve, Invalid More...
 
enum class  DiscountingMethodEnum { Standard = 1 , ConstantTimeValueOfMoney = 2 , Invalid = 3 }
 The available values are: Standard, ConstantTimeValueOfMoney, Invalid More...
 
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

 FxForwardModelOptionsAllOf (ForwardRateObservableTypeEnum forwardRateObservableType=default(ForwardRateObservableTypeEnum), DiscountingMethodEnum discountingMethod=default(DiscountingMethodEnum), bool convertToReportCcy=default(bool), ModelOptionsTypeEnum modelOptionsType=default(ModelOptionsTypeEnum))
 Initializes a new instance of the FxForwardModelOptionsAllOf 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 (FxForwardModelOptionsAllOf input)
 Returns true if FxForwardModelOptionsAllOf instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 FxForwardModelOptionsAllOf ()
 Initializes a new instance of the FxForwardModelOptionsAllOf class. More...
 

Properties

ForwardRateObservableTypeEnum ForwardRateObservableType [get, set]
 The available values are: ForwardPoints, ForwardRate, RatesCurve, FxForwardCurve, Invalid More...
 
DiscountingMethodEnum DiscountingMethod [get, set]
 The available values are: Standard, ConstantTimeValueOfMoney, Invalid More...
 
ModelOptionsTypeEnum ModelOptionsType [get, set]
 The available values are: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions More...
 
bool ConvertToReportCcy [get, set]
 Convert all FX flows to the report currency By setting this all FX forwards will be priced using Forward Curves that have Report Currency as the base. More...
 

Detailed Description

FxForwardModelOptionsAllOf

Member Enumeration Documentation

◆ DiscountingMethodEnum

The available values are: Standard, ConstantTimeValueOfMoney, Invalid

The available values are: Standard, ConstantTimeValueOfMoney, Invalid

Enumerator
Standard 

Enum Standard for value: Standard

ConstantTimeValueOfMoney 

Enum ConstantTimeValueOfMoney for value: ConstantTimeValueOfMoney

Invalid 

Enum Invalid for value: Invalid

◆ ForwardRateObservableTypeEnum

The available values are: ForwardPoints, ForwardRate, RatesCurve, FxForwardCurve, Invalid

The available values are: ForwardPoints, ForwardRate, RatesCurve, FxForwardCurve, Invalid

Enumerator
ForwardPoints 

Enum ForwardPoints for value: ForwardPoints

ForwardRate 

Enum ForwardRate for value: ForwardRate

RatesCurve 

Enum RatesCurve for value: RatesCurve

FxForwardCurve 

Enum FxForwardCurve for value: FxForwardCurve

Invalid 

Enum Invalid for value: Invalid

◆ ModelOptionsTypeEnum

The available values are: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions

The available values are: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions

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

Constructor & Destructor Documentation

◆ FxForwardModelOptionsAllOf() [1/2]

Lusid.Sdk.Model.FxForwardModelOptionsAllOf.FxForwardModelOptionsAllOf ( )
inlineprotected

Initializes a new instance of the FxForwardModelOptionsAllOf class.

◆ FxForwardModelOptionsAllOf() [2/2]

Lusid.Sdk.Model.FxForwardModelOptionsAllOf.FxForwardModelOptionsAllOf ( ForwardRateObservableTypeEnum  forwardRateObservableType = default(ForwardRateObservableTypeEnum),
DiscountingMethodEnum  discountingMethod = default(DiscountingMethodEnum),
bool  convertToReportCcy = default(bool),
ModelOptionsTypeEnum  modelOptionsType = default(ModelOptionsTypeEnum) 
)
inline

Initializes a new instance of the FxForwardModelOptionsAllOf class.

Parameters
forwardRateObservableTypeThe available values are: ForwardPoints, ForwardRate, RatesCurve, FxForwardCurve, Invalid (required).
discountingMethodThe available values are: Standard, ConstantTimeValueOfMoney, Invalid (required).
convertToReportCcyConvert all FX flows to the report currency By setting this all FX forwards will be priced using Forward Curves that have Report Currency as the base. (required).
modelOptionsTypeThe available values are: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions (required).

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if FxForwardModelOptionsAllOf instances are equal

Parameters
inputInstance of FxForwardModelOptionsAllOf to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.FxForwardModelOptionsAllOf.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ ConvertToReportCcy

bool Lusid.Sdk.Model.FxForwardModelOptionsAllOf.ConvertToReportCcy
getset

Convert all FX flows to the report currency By setting this all FX forwards will be priced using Forward Curves that have Report Currency as the base.

Convert all FX flows to the report currency By setting this all FX forwards will be priced using Forward Curves that have Report Currency as the base.

◆ DiscountingMethod

DiscountingMethodEnum Lusid.Sdk.Model.FxForwardModelOptionsAllOf.DiscountingMethod
getset

The available values are: Standard, ConstantTimeValueOfMoney, Invalid

The available values are: Standard, ConstantTimeValueOfMoney, Invalid

◆ ForwardRateObservableType

ForwardRateObservableTypeEnum Lusid.Sdk.Model.FxForwardModelOptionsAllOf.ForwardRateObservableType
getset

The available values are: ForwardPoints, ForwardRate, RatesCurve, FxForwardCurve, Invalid

The available values are: ForwardPoints, ForwardRate, RatesCurve, FxForwardCurve, Invalid

◆ ModelOptionsType

ModelOptionsTypeEnum Lusid.Sdk.Model.FxForwardModelOptionsAllOf.ModelOptionsType
getset

The available values are: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions

The available values are: Invalid, OpaqueModelOptions, EmptyModelOptions, IndexModelOptions, FxForwardModelOptions, FundingLegModelOptions, EquityModelOptions


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