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

CapFloorAllOf More...

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

Public Types

enum class  InstrumentTypeEnum {
  QuotedSecurity = 1 , InterestRateSwap = 2 , FxForward = 3 , Future = 4 ,
  ExoticInstrument = 5 , FxOption = 6 , CreditDefaultSwap = 7 , InterestRateSwaption = 8 ,
  Bond = 9 , EquityOption = 10 , FixedLeg = 11 , FloatingLeg = 12 ,
  BespokeCashFlowsLeg = 13 , Unknown = 14 , TermDeposit = 15 , ContractForDifference = 16 ,
  EquitySwap = 17 , CashPerpetual = 18 , CapFloor = 19 , CashSettled = 20 ,
  CdsIndex = 21 , Basket = 22 , FundingLeg = 23 , FxSwap = 24 ,
  ForwardRateAgreement = 25 , SimpleInstrument = 26 , Repo = 27 , Equity = 28 ,
  ExchangeTradedOption = 29 , ReferenceInstrument = 30 , ComplexBond = 31 , InflationLinkedBond = 32 ,
  InflationSwap = 33 , SimpleCashFlowLoan = 34 , TotalReturnSwap = 35 , InflationLeg = 36 ,
  FundShareClass = 37 , FlexibleLoan = 38
}
 The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan More...
 

Public Member Functions

 CapFloorAllOf (string capFloorType=default(string), decimal capStrike=default(decimal), decimal floorStrike=default(decimal), bool includeFirstCaplet=default(bool), FloatingLeg underlyingFloatingLeg=default(FloatingLeg), InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
 Initializes a new instance of the CapFloorAllOf 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 (CapFloorAllOf input)
 Returns true if CapFloorAllOf instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

InstrumentTypeEnum InstrumentType [get, set]
 The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan More...
 
string CapFloorType [get, set]
 Determine if it's CAP, FLOOR, or COLLAR. Supported string (enumeration) values are: [Cap, Floor, Collar]. More...
 
decimal CapStrike [get, set]
 Strike rate of the Cap. More...
 
decimal FloorStrike [get, set]
 Strike rate of the Floor. More...
 
bool IncludeFirstCaplet [get, set]
 Include first caplet flag. More...
 
FloatingLeg UnderlyingFloatingLeg [get, set]
 Gets or Sets UnderlyingFloatingLeg More...
 

Detailed Description

CapFloorAllOf

Member Enumeration Documentation

◆ InstrumentTypeEnum

The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan

The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan

Enumerator
QuotedSecurity 

Enum QuotedSecurity for value: QuotedSecurity

InterestRateSwap 

Enum InterestRateSwap for value: InterestRateSwap

FxForward 

Enum FxForward for value: FxForward

Future 

Enum Future for value: Future

ExoticInstrument 

Enum ExoticInstrument for value: ExoticInstrument

FxOption 

Enum FxOption for value: FxOption

CreditDefaultSwap 

Enum CreditDefaultSwap for value: CreditDefaultSwap

InterestRateSwaption 

Enum InterestRateSwaption for value: InterestRateSwaption

Bond 

Enum Bond for value: Bond

EquityOption 

Enum EquityOption for value: EquityOption

FixedLeg 

Enum FixedLeg for value: FixedLeg

FloatingLeg 

Enum FloatingLeg for value: FloatingLeg

BespokeCashFlowsLeg 

Enum BespokeCashFlowsLeg for value: BespokeCashFlowsLeg

Unknown 

Enum Unknown for value: Unknown

TermDeposit 

Enum TermDeposit for value: TermDeposit

ContractForDifference 

Enum ContractForDifference for value: ContractForDifference

EquitySwap 

Enum EquitySwap for value: EquitySwap

CashPerpetual 

Enum CashPerpetual for value: CashPerpetual

CapFloor 

Enum CapFloor for value: CapFloor

CashSettled 

Enum CashSettled for value: CashSettled

CdsIndex 

Enum CdsIndex for value: CdsIndex

Basket 

Enum Basket for value: Basket

FundingLeg 

Enum FundingLeg for value: FundingLeg

FxSwap 

Enum FxSwap for value: FxSwap

ForwardRateAgreement 

Enum ForwardRateAgreement for value: ForwardRateAgreement

SimpleInstrument 

Enum SimpleInstrument for value: SimpleInstrument

Repo 

Enum Repo for value: Repo

Equity 

Enum Equity for value: Equity

ExchangeTradedOption 

Enum ExchangeTradedOption for value: ExchangeTradedOption

ReferenceInstrument 

Enum ReferenceInstrument for value: ReferenceInstrument

ComplexBond 

Enum ComplexBond for value: ComplexBond

InflationLinkedBond 

Enum InflationLinkedBond for value: InflationLinkedBond

InflationSwap 

Enum InflationSwap for value: InflationSwap

SimpleCashFlowLoan 

Enum SimpleCashFlowLoan for value: SimpleCashFlowLoan

TotalReturnSwap 

Enum TotalReturnSwap for value: TotalReturnSwap

InflationLeg 

Enum InflationLeg for value: InflationLeg

FundShareClass 

Enum FundShareClass for value: FundShareClass

FlexibleLoan 

Enum FlexibleLoan for value: FlexibleLoan

Constructor & Destructor Documentation

◆ CapFloorAllOf() [1/2]

Lusid.Sdk.Model.CapFloorAllOf.CapFloorAllOf ( )
inlineprotected

Initializes a new instance of the CapFloorAllOf class.

◆ CapFloorAllOf() [2/2]

Lusid.Sdk.Model.CapFloorAllOf.CapFloorAllOf ( string  capFloorType = default(string),
decimal  capStrike = default(decimal),
decimal  floorStrike = default(decimal),
bool  includeFirstCaplet = default(bool),
FloatingLeg  underlyingFloatingLeg = default(FloatingLeg),
InstrumentTypeEnum  instrumentType = default(InstrumentTypeEnum) 
)
inline

Initializes a new instance of the CapFloorAllOf class.

Parameters
capFloorTypeDetermine if it's CAP, FLOOR, or COLLAR. Supported string (enumeration) values are: [Cap, Floor, Collar]. (required).
capStrikeStrike rate of the Cap. (required).
floorStrikeStrike rate of the Floor. (required).
includeFirstCapletInclude first caplet flag. (required).
underlyingFloatingLegunderlyingFloatingLeg (required).
instrumentTypeThe available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan (required).

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if CapFloorAllOf instances are equal

Parameters
inputInstance of CapFloorAllOf to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ CapFloorType

string Lusid.Sdk.Model.CapFloorAllOf.CapFloorType
getset

Determine if it's CAP, FLOOR, or COLLAR. Supported string (enumeration) values are: [Cap, Floor, Collar].

Determine if it's CAP, FLOOR, or COLLAR. Supported string (enumeration) values are: [Cap, Floor, Collar].

◆ CapStrike

decimal Lusid.Sdk.Model.CapFloorAllOf.CapStrike
getset

Strike rate of the Cap.

Strike rate of the Cap.

◆ FloorStrike

decimal Lusid.Sdk.Model.CapFloorAllOf.FloorStrike
getset

Strike rate of the Floor.

Strike rate of the Floor.

◆ IncludeFirstCaplet

bool Lusid.Sdk.Model.CapFloorAllOf.IncludeFirstCaplet
getset

Include first caplet flag.

Include first caplet flag.

◆ InstrumentType

InstrumentTypeEnum Lusid.Sdk.Model.CapFloorAllOf.InstrumentType
getset

◆ UnderlyingFloatingLeg

FloatingLeg Lusid.Sdk.Model.CapFloorAllOf.UnderlyingFloatingLeg
getset

Gets or Sets UnderlyingFloatingLeg


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