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

Descriptive information that describes a particular basket of instruments. Most commonly required with a CDS Index or similarly defined instrument. More...

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

Public Member Functions

 BasketIdentifier (string index=default(string), string name=default(string), string region=default(string), int seriesId=default(int))
 Initializes a new instance of the BasketIdentifier 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 (BasketIdentifier input)
 Returns true if BasketIdentifier instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string Index [get, set]
 Index set, e.g. iTraxx or CDX. More...
 
string Name [get, set]
 The index name within the set, e.g. "MAIN" or "Crossover". More...
 
string Region [get, set]
 Applicable geographic country or region. Typically something like "Europe", "Asia ex-Japan", "Japan" or "Australia". More...
 
int SeriesId [get, set]
 The series identifier. More...
 

Detailed Description

Descriptive information that describes a particular basket of instruments. Most commonly required with a CDS Index or similarly defined instrument.

Constructor & Destructor Documentation

◆ BasketIdentifier() [1/2]

Lusid.Sdk.Model.BasketIdentifier.BasketIdentifier ( )
inlineprotected

Initializes a new instance of the BasketIdentifier class.

◆ BasketIdentifier() [2/2]

Lusid.Sdk.Model.BasketIdentifier.BasketIdentifier ( string  index = default(string),
string  name = default(string),
string  region = default(string),
int  seriesId = default(int) 
)
inline

Initializes a new instance of the BasketIdentifier class.

Parameters
indexIndex set, e.g. iTraxx or CDX. (required).
nameThe index name within the set, e.g. "MAIN" or "Crossover". (required).
regionApplicable geographic country or region. Typically something like "Europe", "Asia ex-Japan", "Japan" or "Australia". (required).
seriesIdThe series identifier. (required).

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if BasketIdentifier instances are equal

Parameters
inputInstance of BasketIdentifier to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Index

string Lusid.Sdk.Model.BasketIdentifier.Index
getset

Index set, e.g. iTraxx or CDX.

Index set, e.g. iTraxx or CDX.

◆ Name

string Lusid.Sdk.Model.BasketIdentifier.Name
getset

The index name within the set, e.g. "MAIN" or "Crossover".

The index name within the set, e.g. "MAIN" or "Crossover".

◆ Region

string Lusid.Sdk.Model.BasketIdentifier.Region
getset

Applicable geographic country or region. Typically something like "Europe", "Asia ex-Japan", "Japan" or "Australia".

Applicable geographic country or region. Typically something like "Europe", "Asia ex-Japan", "Japan" or "Australia".

◆ SeriesId

int Lusid.Sdk.Model.BasketIdentifier.SeriesId
getset

The series identifier.

The series identifier.


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