A list of Composite Breakdowns. More...

Inheritance diagram for Lusid.Sdk.Model.PortfolioReturnBreakdown:

Public Member Functions
	PortfolioReturnBreakdown (ResourceId portfolioId=default(ResourceId), decimal rateOfReturn=default(decimal), decimal? openingMarketValue=default(decimal?), decimal? closingMarketValue=default(decimal?), decimal weight=default(decimal), int constituentsInTheComposite=default(int), int constituentsMissing=default(int), string currency=default(string), decimal openFxRate=default(decimal), decimal closeFxRate=default(decimal), decimal? localRateOfReturn=default(decimal?), decimal? localOpeningMarketValue=default(decimal?), decimal? localClosingMarketValue=default(decimal?))
	Initializes a new instance of the PortfolioReturnBreakdown 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 (PortfolioReturnBreakdown input)
	Returns true if PortfolioReturnBreakdown instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	PortfolioReturnBreakdown ()
	Initializes a new instance of the PortfolioReturnBreakdown class. More...

Properties
ResourceId	PortfolioId `[get, set]`
	Gets or Sets PortfolioId More...

decimal	RateOfReturn `[get, set]`
	The return number. More...

decimal?	OpeningMarketValue `[get, set]`
	The opening market value. More...

decimal?	ClosingMarketValue `[get, set]`
	The closing market value. More...

decimal	Weight `[get, set]`
	The weight of the constituent into the composite. More...

int	ConstituentsInTheComposite `[get, set]`
	The number of members in the Composite on the given day. More...

int	ConstituentsMissing `[get, set]`
	The number of the constituents which have a missing return on that day. More...

string	Currency `[get, set]`
	The currency of the portfolio. More...

decimal	OpenFxRate `[get, set]`
	The opening fxRate which is used in calculation. More...

decimal	CloseFxRate `[get, set]`
	The closing fxRate which is used in calculation. More...

decimal?	LocalRateOfReturn `[get, set]`
	The rate of return in the local currency. More...

decimal?	LocalOpeningMarketValue `[get, set]`
	The opening market value in the local currency. More...

decimal?	LocalClosingMarketValue `[get, set]`
	The closing market value in the local currency. More...

Detailed Description

A list of Composite Breakdowns.

Constructor & Destructor Documentation

◆ PortfolioReturnBreakdown() [1/2]

Lusid.Sdk.Model.PortfolioReturnBreakdown.PortfolioReturnBreakdown ( )

inlineprotected

Initializes a new instance of the PortfolioReturnBreakdown class.

◆ PortfolioReturnBreakdown() [2/2]

Lusid.Sdk.Model.PortfolioReturnBreakdown.PortfolioReturnBreakdown	(	ResourceId	portfolioId = `default(ResourceId)`,
		decimal	rateOfReturn = `default(decimal)`,
		decimal?	openingMarketValue = `default(decimal?)`,
		decimal?	closingMarketValue = `default(decimal?)`,
		decimal	weight = `default(decimal)`,
		int	constituentsInTheComposite = `default(int)`,
		int	constituentsMissing = `default(int)`,
		string	currency = `default(string)`,
		decimal	openFxRate = `default(decimal)`,
		decimal	closeFxRate = `default(decimal)`,
		decimal?	localRateOfReturn = `default(decimal?)`,
		decimal?	localOpeningMarketValue = `default(decimal?)`,
		decimal?	localClosingMarketValue = `default(decimal?)`
	)

inline

Initializes a new instance of the PortfolioReturnBreakdown class.

Parameters

portfolioId	portfolioId (required).
rateOfReturn	The return number..
openingMarketValue	The opening market value..
closingMarketValue	The closing market value..
weight	The weight of the constituent into the composite..
constituentsInTheComposite	The number of members in the Composite on the given day..
constituentsMissing	The number of the constituents which have a missing return on that day..
currency	The currency of the portfolio..
openFxRate	The opening fxRate which is used in calculation..
closeFxRate	The closing fxRate which is used in calculation..
localRateOfReturn	The rate of return in the local currency..
localOpeningMarketValue	The opening market value in the local currency..
localClosingMarketValue	The closing market value in the local currency..

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if PortfolioReturnBreakdown instances are equal

Parameters

input Instance of PortfolioReturnBreakdown to be compared

Returns: Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.PortfolioReturnBreakdown.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.PortfolioReturnBreakdown.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.PortfolioReturnBreakdown.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ CloseFxRate

decimal Lusid.Sdk.Model.PortfolioReturnBreakdown.CloseFxRate

getset

The closing fxRate which is used in calculation.

◆ ClosingMarketValue

decimal? Lusid.Sdk.Model.PortfolioReturnBreakdown.ClosingMarketValue

getset

The closing market value.

◆ ConstituentsInTheComposite

int Lusid.Sdk.Model.PortfolioReturnBreakdown.ConstituentsInTheComposite

getset

The number of members in the Composite on the given day.

◆ ConstituentsMissing

int Lusid.Sdk.Model.PortfolioReturnBreakdown.ConstituentsMissing

getset

The number of the constituents which have a missing return on that day.

◆ Currency

string Lusid.Sdk.Model.PortfolioReturnBreakdown.Currency

getset

The currency of the portfolio.

◆ LocalClosingMarketValue

decimal? Lusid.Sdk.Model.PortfolioReturnBreakdown.LocalClosingMarketValue

getset

The closing market value in the local currency.

◆ LocalOpeningMarketValue

decimal? Lusid.Sdk.Model.PortfolioReturnBreakdown.LocalOpeningMarketValue

getset

The opening market value in the local currency.

◆ LocalRateOfReturn

decimal? Lusid.Sdk.Model.PortfolioReturnBreakdown.LocalRateOfReturn

getset

The rate of return in the local currency.

◆ OpenFxRate

decimal Lusid.Sdk.Model.PortfolioReturnBreakdown.OpenFxRate

getset

The opening fxRate which is used in calculation.

◆ OpeningMarketValue

decimal? Lusid.Sdk.Model.PortfolioReturnBreakdown.OpeningMarketValue

getset

The opening market value.

◆ PortfolioId

ResourceId Lusid.Sdk.Model.PortfolioReturnBreakdown.PortfolioId

getset

Gets or Sets PortfolioId

◆ RateOfReturn

decimal Lusid.Sdk.Model.PortfolioReturnBreakdown.RateOfReturn

getset

The return number.

◆ Weight

decimal Lusid.Sdk.Model.PortfolioReturnBreakdown.Weight

getset

The weight of the constituent into the composite.

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/PortfolioReturnBreakdown.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PortfolioReturnBreakdown() [1/2]

◆ PortfolioReturnBreakdown() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ CloseFxRate

◆ ClosingMarketValue

◆ ConstituentsInTheComposite

◆ ConstituentsMissing

◆ Currency

◆ LocalClosingMarketValue

◆ LocalOpeningMarketValue

◆ LocalRateOfReturn

◆ OpenFxRate

◆ OpeningMarketValue

◆ PortfolioId

◆ RateOfReturn

◆ Weight