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

LUSID representation of a basket of instruments. More...

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

Public Member Functions

 Basket (BasketIdentifier basketName=default(BasketIdentifier), string basketType=default(string), WeightedInstruments weightedInstruments=default(WeightedInstruments), InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
 Initializes a new instance of the Basket 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 (Basket input)
 Returns true if Basket instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
- Public Member Functions inherited from Lusid.Sdk.Model.LusidInstrument
 LusidInstrument (InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
 Initializes a new instance of the LusidInstrument 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 (LusidInstrument input)
 Returns true if LusidInstrument instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

BasketIdentifier BasketName [get, set]
 Gets or Sets BasketName More...
 
string BasketType [get, set]
 What contents does the basket have. The validation will check that the instrument types contained match those expected. Supported string (enumeration) values are: [Bonds, Credits, Equities, EquitySwap]. More...
 
WeightedInstruments WeightedInstruments [get, set]
 Gets or Sets WeightedInstruments More...
 
- Properties inherited from Lusid.Sdk.Model.LusidInstrument
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 More...
 

Additional Inherited Members

- Public Types inherited from Lusid.Sdk.Model.LusidInstrument
enum  InstrumentTypeEnum {
  InstrumentTypeEnum.QuotedSecurity = 1, InstrumentTypeEnum.InterestRateSwap = 2, InstrumentTypeEnum.FxForward = 3, InstrumentTypeEnum.Future = 4,
  InstrumentTypeEnum.ExoticInstrument = 5, InstrumentTypeEnum.FxOption = 6, InstrumentTypeEnum.CreditDefaultSwap = 7, InstrumentTypeEnum.InterestRateSwaption = 8,
  InstrumentTypeEnum.Bond = 9, InstrumentTypeEnum.EquityOption = 10, InstrumentTypeEnum.FixedLeg = 11, InstrumentTypeEnum.FloatingLeg = 12,
  InstrumentTypeEnum.BespokeCashFlowsLeg = 13, InstrumentTypeEnum.Unknown = 14, InstrumentTypeEnum.TermDeposit = 15, InstrumentTypeEnum.ContractForDifference = 16,
  InstrumentTypeEnum.EquitySwap = 17, InstrumentTypeEnum.CashPerpetual = 18, InstrumentTypeEnum.CapFloor = 19, InstrumentTypeEnum.CashSettled = 20,
  InstrumentTypeEnum.CdsIndex = 21, InstrumentTypeEnum.Basket = 22, InstrumentTypeEnum.FundingLeg = 23, InstrumentTypeEnum.FxSwap = 24,
  InstrumentTypeEnum.ForwardRateAgreement = 25, InstrumentTypeEnum.SimpleInstrument = 26, InstrumentTypeEnum.Repo = 27, InstrumentTypeEnum.Equity = 28,
  InstrumentTypeEnum.ExchangeTradedOption = 29, InstrumentTypeEnum.ReferenceInstrument = 30, InstrumentTypeEnum.ComplexBond = 31, InstrumentTypeEnum.InflationLinkedBond = 32,
  InstrumentTypeEnum.InflationSwap = 33, InstrumentTypeEnum.SimpleCashFlowLoan = 34
}
 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 More...
 

Detailed Description

LUSID representation of a basket of instruments.

Constructor & Destructor Documentation

◆ Basket() [1/2]

Lusid.Sdk.Model.Basket.Basket ( )
inlineprotected

Initializes a new instance of the Basket class.

◆ Basket() [2/2]

Lusid.Sdk.Model.Basket.Basket ( BasketIdentifier  basketName = default(BasketIdentifier),
string  basketType = default(string),
WeightedInstruments  weightedInstruments = default(WeightedInstruments),
InstrumentTypeEnum  instrumentType = default(InstrumentTypeEnum) 
)
inline

Initializes a new instance of the Basket class.

Parameters
basketNamebasketName (required).
basketTypeWhat contents does the basket have. The validation will check that the instrument types contained match those expected. Supported string (enumeration) values are: [Bonds, Credits, Equities, EquitySwap]. (required).
weightedInstrumentsweightedInstruments (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 (required) (default to "Basket").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if Basket instances are equal

Parameters
inputInstance of Basket to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.LusidInstrument.

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ BasketName

BasketIdentifier Lusid.Sdk.Model.Basket.BasketName
getset

Gets or Sets BasketName

◆ BasketType

string Lusid.Sdk.Model.Basket.BasketType
getset

What contents does the basket have. The validation will check that the instrument types contained match those expected. Supported string (enumeration) values are: [Bonds, Credits, Equities, EquitySwap].

What contents does the basket have. The validation will check that the instrument types contained match those expected. Supported string (enumeration) values are: [Bonds, Credits, Equities, EquitySwap].

◆ WeightedInstruments

WeightedInstruments Lusid.Sdk.Model.Basket.WeightedInstruments
getset

Gets or Sets WeightedInstruments


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