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

Used to append a new point to an FX curve defined using `FxForwardPipsCurveData`. More...

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

Public Member Functions

 AppendFxForwardPipsCurveData (DateTimeOffset date=default(DateTimeOffset), decimal pipRate=default(decimal), MarketDataTypeEnum marketDataType=default(MarketDataTypeEnum))
 Initializes a new instance of the AppendFxForwardPipsCurveData 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 (AppendFxForwardPipsCurveData input)
 Returns true if AppendFxForwardPipsCurveData instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
- Public Member Functions inherited from Lusid.Sdk.Model.AppendMarketData
 AppendMarketData (MarketDataTypeEnum marketDataType=default(MarketDataTypeEnum))
 Initializes a new instance of the AppendMarketData 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 (AppendMarketData input)
 Returns true if AppendMarketData instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

DateTimeOffset Date [get, set]
 Date for which the forward rate applies. More...
 
decimal PipRate [get, set]
 Rate provided for the fx forward (price in FgnCcy per unit of DomCcy), expressed in pips. More...
 
- Properties inherited from Lusid.Sdk.Model.AppendMarketData
MarketDataTypeEnum MarketDataType [get, set]
 Available values: AppendFxForwardCurveByQuoteReference, AppendFxForwardCurveData, AppendFxForwardPipsCurveData, AppendFxForwardTenorCurveData, AppendFxForwardTenorPipsCurveData. More...
 

Additional Inherited Members

- Public Types inherited from Lusid.Sdk.Model.AppendMarketData
enum class  MarketDataTypeEnum {
  AppendFxForwardCurveByQuoteReference = 1 , AppendFxForwardCurveData = 2 , AppendFxForwardPipsCurveData = 3 , AppendFxForwardTenorCurveData = 4 ,
  AppendFxForwardTenorPipsCurveData = 5
}
 Available values: AppendFxForwardCurveByQuoteReference, AppendFxForwardCurveData, AppendFxForwardPipsCurveData, AppendFxForwardTenorCurveData, AppendFxForwardTenorPipsCurveData. More...
 

Detailed Description

Used to append a new point to an FX curve defined using &#x60;FxForwardPipsCurveData&#x60;.

Constructor & Destructor Documentation

◆ AppendFxForwardPipsCurveData() [1/2]

Lusid.Sdk.Model.AppendFxForwardPipsCurveData.AppendFxForwardPipsCurveData ( )
inlineprotected

Initializes a new instance of the AppendFxForwardPipsCurveData class.

◆ AppendFxForwardPipsCurveData() [2/2]

Lusid.Sdk.Model.AppendFxForwardPipsCurveData.AppendFxForwardPipsCurveData ( DateTimeOffset  date = default(DateTimeOffset),
decimal  pipRate = default(decimal),
MarketDataTypeEnum  marketDataType = default(MarketDataTypeEnum) 
)
inline

Initializes a new instance of the AppendFxForwardPipsCurveData class.

Parameters
dateDate for which the forward rate applies. (required).
pipRateRate provided for the fx forward (price in FgnCcy per unit of DomCcy), expressed in pips. (required).
marketDataTypeAvailable values: AppendFxForwardCurveByQuoteReference, AppendFxForwardCurveData, AppendFxForwardPipsCurveData, AppendFxForwardTenorCurveData, AppendFxForwardTenorPipsCurveData. (required) (default to "AppendFxForwardPipsCurveData").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if AppendFxForwardPipsCurveData instances are equal

Parameters
inputInstance of AppendFxForwardPipsCurveData to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.AppendMarketData.

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Date

DateTimeOffset Lusid.Sdk.Model.AppendFxForwardPipsCurveData.Date
getset

Date for which the forward rate applies.

Date for which the forward rate applies.

◆ PipRate

decimal Lusid.Sdk.Model.AppendFxForwardPipsCurveData.PipRate
getset

Rate provided for the fx forward (price in FgnCcy per unit of DomCcy), expressed in pips.

Rate provided for the fx forward (price in FgnCcy per unit of DomCcy), expressed in pips.


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