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

ShareClass More...

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

Public Member Functions

 ShareClass (Dictionary< string, string > instrumentIdentifiers=default(Dictionary< string, string >), List< Series > series=default(List< Series >), string code=default(string), string name=default(string), string description=default(string), string shareClassShortCode=default(string), decimal? launchPrice=default(decimal?), DateTimeOffset? launchDate=default(DateTimeOffset?), decimal? apportionmentFactor=default(decimal?), Dictionary< string, Property > properties=default(Dictionary< string, Property >), string fundShareClassType=default(string), string distributionType=default(string), string domCcy=default(string), TradingConventions tradingConventions=default(TradingConventions), int? unitsPrecision=default(int?), int? pricePrecision=default(int?), List< SimpleRoundingConvention > roundingConventions=default(List< SimpleRoundingConvention >), List< SimpleRoundingConvention > roundingConventionsUnits=default(List< SimpleRoundingConvention >), TimeZoneConventions timeZoneConventions=default(TimeZoneConventions), string distributionPaymentType=default(string), string hedging=default(string))
 Initializes a new instance of the ShareClass 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 (ShareClass input)
 Returns true if ShareClass instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

Dictionary< string, string > InstrumentIdentifiers [get, set]
 Unique instrument identifiers More...
 
List< SeriesSeries [get, set]
 The series that belong to this Share Class. More...
 
string Code [get, set]
 The unique code for the Share Class. Must be unique within the Fund. More...
 
string Name [get, set]
 The display name of the Share Class. More...
 
string Description [get, set]
 An optional description for the Share Class. More...
 
string ShareClassShortCode [get, set]
 A short code that uniquely identifies the share class within the Fund. More...
 
decimal? LaunchPrice [get, set]
 The launch price set when a shareclass is added to the fund. Defaults to 1. More...
 
DateTimeOffset? LaunchDate [get, set]
 The launch date set when a shareclass is added to the fund. Defaults to Fund Inception Date. More...
 
decimal? ApportionmentFactor [get, set]
 The weighting factor used for apportionment across this share class. More...
 
Dictionary< string, PropertyProperties [get, set]
 An optional set of properties to attach to the auto-created Instrument. Only applied when createInstrument is true. More...
 
string FundShareClassType [get, set]
 The Type of Share Class. Available values: Unitised, Inactive, Series, PrivateEquity, Partnership. More...
 
string DistributionType [get, set]
 The type of distribution the ShareClass will calculate. Available values: Income, Accumulation. More...
 
string DomCcy [get, set]
 The domestic currency of the ShareClass instrument. More...
 
TradingConventions TradingConventions [get, set]
 Gets or Sets TradingConventions More...
 
int? UnitsPrecision [get, set]
 Decimal places for the share class units. More...
 
int? PricePrecision [get, set]
 Decimal places for the share class price. More...
 
List< SimpleRoundingConventionRoundingConventions [get, set]
 Rounding conventions used for the ShareClass quotes. More...
 
List< SimpleRoundingConventionRoundingConventionsUnits [get, set]
 Rounding conventions used for the ShareClass units. More...
 
TimeZoneConventions TimeZoneConventions [get, set]
 Gets or Sets TimeZoneConventions More...
 
string DistributionPaymentType [get, set]
 The tax treatment applied to distributions. Available values: Invalid, Gross, Net. More...
 
string Hedging [get, set]
 Indicates whether the ShareClass applies currency hedging. Available values: Invalid, None, ApplyHedging. More...
 

Detailed Description

ShareClass

Constructor & Destructor Documentation

◆ ShareClass() [1/2]

Lusid.Sdk.Model.ShareClass.ShareClass ( )
inlineprotected

Initializes a new instance of the ShareClass class.

◆ ShareClass() [2/2]

Lusid.Sdk.Model.ShareClass.ShareClass ( Dictionary< string, string >  instrumentIdentifiers = default(Dictionary<string, string>),
List< Series series = default(List<Series>),
string  code = default(string),
string  name = default(string),
string  description = default(string),
string  shareClassShortCode = default(string),
decimal?  launchPrice = default(decimal?),
DateTimeOffset?  launchDate = default(DateTimeOffset?),
decimal?  apportionmentFactor = default(decimal?),
Dictionary< string, Property properties = default(Dictionary<string, Property>),
string  fundShareClassType = default(string),
string  distributionType = default(string),
string  domCcy = default(string),
TradingConventions  tradingConventions = default(TradingConventions),
int?  unitsPrecision = default(int?),
int?  pricePrecision = default(int?),
List< SimpleRoundingConvention roundingConventions = default(List<SimpleRoundingConvention>),
List< SimpleRoundingConvention roundingConventionsUnits = default(List<SimpleRoundingConvention>),
TimeZoneConventions  timeZoneConventions = default(TimeZoneConventions),
string  distributionPaymentType = default(string),
string  hedging = default(string) 
)
inline

Initializes a new instance of the ShareClass class.

Parameters
instrumentIdentifiersUnique instrument identifiers (required).
seriesThe series that belong to this Share Class..
codeThe unique code for the Share Class. Must be unique within the Fund. (required).
nameThe display name of the Share Class. (required).
descriptionAn optional description for the Share Class..
shareClassShortCodeA short code that uniquely identifies the share class within the Fund. (required).
launchPriceThe launch price set when a shareclass is added to the fund. Defaults to 1..
launchDateThe launch date set when a shareclass is added to the fund. Defaults to Fund Inception Date..
apportionmentFactorThe weighting factor used for apportionment across this share class..
propertiesAn optional set of properties to attach to the auto-created Instrument. Only applied when createInstrument is true..
fundShareClassTypeThe Type of Share Class. Available values: Unitised, Inactive, Series, PrivateEquity, Partnership. (required).
distributionTypeThe type of distribution the ShareClass will calculate. Available values: Income, Accumulation. (required).
domCcyThe domestic currency of the ShareClass instrument. (required).
tradingConventionstradingConventions.
unitsPrecisionDecimal places for the share class units..
pricePrecisionDecimal places for the share class price..
roundingConventionsRounding conventions used for the ShareClass quotes..
roundingConventionsUnitsRounding conventions used for the ShareClass units..
timeZoneConventionstimeZoneConventions.
distributionPaymentTypeThe tax treatment applied to distributions. Available values: Invalid, Gross, Net..
hedgingIndicates whether the ShareClass applies currency hedging. Available values: Invalid, None, ApplyHedging. (required).

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if ShareClass instances are equal

Parameters
inputInstance of ShareClass to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ ApportionmentFactor

decimal? Lusid.Sdk.Model.ShareClass.ApportionmentFactor
getset

The weighting factor used for apportionment across this share class.

The weighting factor used for apportionment across this share class.

◆ Code

string Lusid.Sdk.Model.ShareClass.Code
getset

The unique code for the Share Class. Must be unique within the Fund.

The unique code for the Share Class. Must be unique within the Fund.

◆ Description

string Lusid.Sdk.Model.ShareClass.Description
getset

An optional description for the Share Class.

An optional description for the Share Class.

◆ DistributionPaymentType

string Lusid.Sdk.Model.ShareClass.DistributionPaymentType
getset

The tax treatment applied to distributions. Available values: Invalid, Gross, Net.

The tax treatment applied to distributions. Available values: Invalid, Gross, Net.

◆ DistributionType

string Lusid.Sdk.Model.ShareClass.DistributionType
getset

The type of distribution the ShareClass will calculate. Available values: Income, Accumulation.

The type of distribution the ShareClass will calculate. Available values: Income, Accumulation.

◆ DomCcy

string Lusid.Sdk.Model.ShareClass.DomCcy
getset

The domestic currency of the ShareClass instrument.

The domestic currency of the ShareClass instrument.

◆ FundShareClassType

string Lusid.Sdk.Model.ShareClass.FundShareClassType
getset

The Type of Share Class. Available values: Unitised, Inactive, Series, PrivateEquity, Partnership.

The Type of Share Class. Available values: Unitised, Inactive, Series, PrivateEquity, Partnership.

◆ Hedging

string Lusid.Sdk.Model.ShareClass.Hedging
getset

Indicates whether the ShareClass applies currency hedging. Available values: Invalid, None, ApplyHedging.

Indicates whether the ShareClass applies currency hedging. Available values: Invalid, None, ApplyHedging.

◆ InstrumentIdentifiers

Dictionary<string, string> Lusid.Sdk.Model.ShareClass.InstrumentIdentifiers
getset

Unique instrument identifiers

Unique instrument identifiers

◆ LaunchDate

DateTimeOffset? Lusid.Sdk.Model.ShareClass.LaunchDate
getset

The launch date set when a shareclass is added to the fund. Defaults to Fund Inception Date.

The launch date set when a shareclass is added to the fund. Defaults to Fund Inception Date.

◆ LaunchPrice

decimal? Lusid.Sdk.Model.ShareClass.LaunchPrice
getset

The launch price set when a shareclass is added to the fund. Defaults to 1.

The launch price set when a shareclass is added to the fund. Defaults to 1.

◆ Name

string Lusid.Sdk.Model.ShareClass.Name
getset

The display name of the Share Class.

The display name of the Share Class.

◆ PricePrecision

int? Lusid.Sdk.Model.ShareClass.PricePrecision
getset

Decimal places for the share class price.

Decimal places for the share class price.

◆ Properties

Dictionary<string, Property> Lusid.Sdk.Model.ShareClass.Properties
getset

An optional set of properties to attach to the auto-created Instrument. Only applied when createInstrument is true.

An optional set of properties to attach to the auto-created Instrument. Only applied when createInstrument is true.

◆ RoundingConventions

List<SimpleRoundingConvention> Lusid.Sdk.Model.ShareClass.RoundingConventions
getset

Rounding conventions used for the ShareClass quotes.

Rounding conventions used for the ShareClass quotes.

◆ RoundingConventionsUnits

List<SimpleRoundingConvention> Lusid.Sdk.Model.ShareClass.RoundingConventionsUnits
getset

Rounding conventions used for the ShareClass units.

Rounding conventions used for the ShareClass units.

◆ Series

List<Series> Lusid.Sdk.Model.ShareClass.Series
getset

The series that belong to this Share Class.

The series that belong to this Share Class.

◆ ShareClassShortCode

string Lusid.Sdk.Model.ShareClass.ShareClassShortCode
getset

A short code that uniquely identifies the share class within the Fund.

A short code that uniquely identifies the share class within the Fund.

◆ TimeZoneConventions

TimeZoneConventions Lusid.Sdk.Model.ShareClass.TimeZoneConventions
getset

Gets or Sets TimeZoneConventions

◆ TradingConventions

TradingConventions Lusid.Sdk.Model.ShareClass.TradingConventions
getset

Gets or Sets TradingConventions

◆ UnitsPrecision

int? Lusid.Sdk.Model.ShareClass.UnitsPrecision
getset

Decimal places for the share class units.

Decimal places for the share class units.


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