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

Inheritance diagram for Lusid.Sdk.Model.Basket:

[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, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility More...

Additional Inherited Members
Public Types inherited from Lusid.Sdk.Model.LusidInstrument
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 , UnsettledCash = 39 , Cash = 40 , MasteredInstrument = 41 , LoanFacility = 42 }
	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, UnsettledCash, Cash, MasteredInstrument, LoanFacility 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

basketName	basketName (required).
basketType	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]. (required).
weightedInstruments	weightedInstruments (required).
instrumentType	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, UnsettledCash, Cash, MasteredInstrument, LoanFacility (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

validationContext Validation context

Returns: Validation Result

◆ Equals() [1/2]

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

inline

Returns true if Basket instances are equal

Parameters

input Instance of Basket to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object 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].

◆ WeightedInstruments

WeightedInstruments Lusid.Sdk.Model.Basket.WeightedInstruments

getset

Gets or Sets WeightedInstruments

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/Basket.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Basket() [1/2]

◆ Basket() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ BasketName

◆ BasketType

◆ WeightedInstruments