LUSID representation of a FundShareClass. A ShareClass represents a pool of shares, held by investors, within a fund. A ShareClass can represent a differing investment approach by either Fees, Income, Currency Risk and Investor type.
More...
|
| string | ShortCode [get, set] |
| | A short identifier, unique across a single fund, usually made up of the ShareClass components. Eg "A Accumulation Euro Hedged Class" could become "A Acc H EUR". More...
|
| |
| string | FundShareClassType [get, set] |
| | The type of distribution that the ShareClass will calculate. Can be either 'Income' or 'Accumulation' - Income classes will pay out and Accumulation classes will retain their ShareClass attributable income. Available values: Income, Accumulation. More...
|
| |
| string | DistributionPaymentType [get, set] |
| | The tax treatment applied to any distributions calculated within the ShareClass. Can be either 'Net' (Distribution Calculated net of tax) or 'Gross' (Distribution calculated gross of tax). Available values: Invalid, Gross, Net. More...
|
| |
| string | Hedging [get, set] |
| | A flag to indicate the ShareClass is operating currency hedging as a means to limit currency risk as part of its investment strategy. Available values: Invalid, None, ApplyHedging. More...
|
| |
| string | DomCcy [get, set] |
| | The domestic currency of the instrument. More...
|
| |
| List< SimpleRoundingConvention > | RoundingConventions [get, set] |
| | Rounding Convention used for the FundShareClass quotes More...
|
| |
| TradingConventions | TradingConventions [get, set] |
| | Gets or Sets TradingConventions More...
|
| |
| TimeZoneConventions | TimeZoneConventions [get, set] |
| | Gets or Sets TimeZoneConventions More...
|
| |
| InstrumentTypeEnum | InstrumentType [get, set] |
| | Available values: 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, FlexibleDeposit, FlexibleRepo. More...
|
| |
|
| 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
, FlexibleDeposit = 43
, FlexibleRepo = 44
} |
| | Available values: 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, FlexibleDeposit, FlexibleRepo. More...
|
| |
LUSID representation of a FundShareClass. A ShareClass represents a pool of shares, held by investors, within a fund. A ShareClass can represent a differing investment approach by either Fees, Income, Currency Risk and Investor type.
◆ FundShareClass() [1/2]
| Lusid.Sdk.Model.FundShareClass.FundShareClass |
( |
| ) |
|
|
inlineprotected |
◆ FundShareClass() [2/2]
Initializes a new instance of the FundShareClass class.
- Parameters
-
| shortCode | A short identifier, unique across a single fund, usually made up of the ShareClass components. Eg "A Accumulation Euro Hedged Class" could become "A Acc H EUR". (required). |
| fundShareClassType | The type of distribution that the ShareClass will calculate. Can be either 'Income' or 'Accumulation' - Income classes will pay out and Accumulation classes will retain their ShareClass attributable income. Available values: Income, Accumulation. (required). |
| distributionPaymentType | The tax treatment applied to any distributions calculated within the ShareClass. Can be either 'Net' (Distribution Calculated net of tax) or 'Gross' (Distribution calculated gross of tax). Available values: Invalid, Gross, Net. (required). |
| hedging | A flag to indicate the ShareClass is operating currency hedging as a means to limit currency risk as part of its investment strategy. Available values: Invalid, None, ApplyHedging. (required). |
| domCcy | The domestic currency of the instrument. (required). |
| roundingConventions | Rounding Convention used for the FundShareClass quotes. |
| tradingConventions | tradingConventions. |
| timeZoneConventions | timeZoneConventions. |
| instrumentType | Available values: 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, FlexibleDeposit, FlexibleRepo. (required) (default to "FundShareClass"). |
◆ BaseValidate()
| IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.FundShareClass.BaseValidate |
( |
ValidationContext |
validationContext | ) |
|
|
inlineprotected |
To validate all properties of the instance
- Parameters
-
| validationContext | Validation context |
- Returns
- Validation Result
◆ Equals() [1/2]
Returns true if FundShareClass instances are equal
- Parameters
-
- Returns
- Boolean
◆ Equals() [2/2]
| override bool Lusid.Sdk.Model.FundShareClass.Equals |
( |
object |
input | ) |
|
|
inline |
Returns true if objects are equal
- Parameters
-
| input | Object to be compared |
- Returns
- Boolean
◆ GetHashCode()
| override int Lusid.Sdk.Model.FundShareClass.GetHashCode |
( |
| ) |
|
|
inline |
Gets the hash code
- Returns
- Hash code
◆ ToJson()
| override string Lusid.Sdk.Model.FundShareClass.ToJson |
( |
| ) |
|
|
inlinevirtual |
◆ ToString()
| override string Lusid.Sdk.Model.FundShareClass.ToString |
( |
| ) |
|
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
◆ DistributionPaymentType
| string Lusid.Sdk.Model.FundShareClass.DistributionPaymentType |
|
getset |
The tax treatment applied to any distributions calculated within the ShareClass. Can be either 'Net' (Distribution Calculated net of tax) or 'Gross' (Distribution calculated gross of tax). Available values: Invalid, Gross, Net.
The tax treatment applied to any distributions calculated within the ShareClass. Can be either 'Net' (Distribution Calculated net of tax) or 'Gross' (Distribution calculated gross of tax). Available values: Invalid, Gross, Net.
◆ DomCcy
| string Lusid.Sdk.Model.FundShareClass.DomCcy |
|
getset |
The domestic currency of the instrument.
The domestic currency of the instrument.
◆ FundShareClassType
| string Lusid.Sdk.Model.FundShareClass.FundShareClassType |
|
getset |
The type of distribution that the ShareClass will calculate. Can be either 'Income' or 'Accumulation' - Income classes will pay out and Accumulation classes will retain their ShareClass attributable income. Available values: Income, Accumulation.
The type of distribution that the ShareClass will calculate. Can be either 'Income' or 'Accumulation' - Income classes will pay out and Accumulation classes will retain their ShareClass attributable income. Available values: Income, Accumulation.
◆ Hedging
| string Lusid.Sdk.Model.FundShareClass.Hedging |
|
getset |
A flag to indicate the ShareClass is operating currency hedging as a means to limit currency risk as part of its investment strategy. Available values: Invalid, None, ApplyHedging.
A flag to indicate the ShareClass is operating currency hedging as a means to limit currency risk as part of its investment strategy. Available values: Invalid, None, ApplyHedging.
◆ RoundingConventions
◆ ShortCode
| string Lusid.Sdk.Model.FundShareClass.ShortCode |
|
getset |
A short identifier, unique across a single fund, usually made up of the ShareClass components. Eg "A Accumulation Euro Hedged Class" could become "A Acc H EUR".
A short identifier, unique across a single fund, usually made up of the ShareClass components. Eg "A Accumulation Euro Hedged Class" could become "A Acc H EUR".
◆ TimeZoneConventions
◆ TradingConventions
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/FundShareClass.cs
Public Member Functions inherited from Lusid.Sdk.Model.LusidInstrument