A list of Aggregated Returns. More...

Inheritance diagram for Lusid.Sdk.Model.AggregatedReturn:

Public Member Functions
	AggregatedReturn (DateTimeOffset effectiveAt=default(DateTimeOffset), DateTimeOffset endOfPeriod=default(DateTimeOffset), decimal? openingMarketValue=default(decimal?), decimal? closingMarketValue=default(decimal?), Dictionary< string, decimal > metricsValue=default(Dictionary< string, decimal >), string frequency=default(string), int? compositeMembers=default(int?), List< ResourceId > compositeMembersWithoutReturn=default(List< ResourceId >), List< string > warnings=default(List< string >))
	Initializes a new instance of the AggregatedReturn 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 (AggregatedReturn input)
	Returns true if AggregatedReturn instances are equal More...

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

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

Properties
DateTimeOffset	EffectiveAt `[get, set]`
	The effectiveAt for the return. More...

DateTimeOffset	EndOfPeriod `[get, set]`
	The end of period date. For the monthly period this will be the Month End Date. More...

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

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

Dictionary< string, decimal >	MetricsValue `[get, set]`
	The value for the specified metric. More...

string	Frequency `[get, set]`
	Show the aggregated output returns on a Daily or Monthly period. More...

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

List< ResourceId >	CompositeMembersWithoutReturn `[get, set]`
	List containing Composite members which post no return on the given day. More...

List< string >	Warnings `[get, set]`
	List of the warnings about the calculation of the aggregated return. More...

Detailed Description

A list of Aggregated Returns.

Constructor & Destructor Documentation

◆ AggregatedReturn() [1/2]

Lusid.Sdk.Model.AggregatedReturn.AggregatedReturn ( )

inlineprotected

Initializes a new instance of the AggregatedReturn class.

◆ AggregatedReturn() [2/2]

Lusid.Sdk.Model.AggregatedReturn.AggregatedReturn	(	DateTimeOffset	effectiveAt = `default(DateTimeOffset)`,
		DateTimeOffset	endOfPeriod = `default(DateTimeOffset)`,
		decimal?	openingMarketValue = `default(decimal?)`,
		decimal?	closingMarketValue = `default(decimal?)`,
		Dictionary< string, decimal >	metricsValue = `default(Dictionary<string, decimal>)`,
		string	frequency = `default(string)`,
		int?	compositeMembers = `default(int?)`,
		List< ResourceId >	compositeMembersWithoutReturn = `default(List<ResourceId>)`,
		List< string >	warnings = `default(List<string>)`
	)

inline

Initializes a new instance of the AggregatedReturn class.

Parameters

effectiveAt	The effectiveAt for the return. (required).
endOfPeriod	The end of period date. For the monthly period this will be the Month End Date. (required).
openingMarketValue	The opening market value..
closingMarketValue	The closing market value..
metricsValue	The value for the specified metric. (required).
frequency	Show the aggregated output returns on a Daily or Monthly period..
compositeMembers	The number of members in the Composite on the given day..
compositeMembersWithoutReturn	List containing Composite members which post no return on the given day..
warnings	List of the warnings about the calculation of the aggregated return..

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if AggregatedReturn instances are equal

Parameters

input Instance of AggregatedReturn to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ ClosingMarketValue

decimal? Lusid.Sdk.Model.AggregatedReturn.ClosingMarketValue

getset

The closing market value.

◆ CompositeMembers

int? Lusid.Sdk.Model.AggregatedReturn.CompositeMembers

getset

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

◆ CompositeMembersWithoutReturn

List<ResourceId> Lusid.Sdk.Model.AggregatedReturn.CompositeMembersWithoutReturn

getset

List containing Composite members which post no return on the given day.

◆ EffectiveAt

DateTimeOffset Lusid.Sdk.Model.AggregatedReturn.EffectiveAt

getset

The effectiveAt for the return.

◆ EndOfPeriod

DateTimeOffset Lusid.Sdk.Model.AggregatedReturn.EndOfPeriod

getset

The end of period date. For the monthly period this will be the Month End Date.

◆ Frequency

string Lusid.Sdk.Model.AggregatedReturn.Frequency

getset

Show the aggregated output returns on a Daily or Monthly period.

◆ MetricsValue

Dictionary<string, decimal> Lusid.Sdk.Model.AggregatedReturn.MetricsValue

getset

The value for the specified metric.

◆ OpeningMarketValue

decimal? Lusid.Sdk.Model.AggregatedReturn.OpeningMarketValue

getset

The opening market value.

◆ Warnings

List<string> Lusid.Sdk.Model.AggregatedReturn.Warnings

getset

List of the warnings about the calculation of the aggregated return.

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

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ AggregatedReturn() [1/2]

◆ AggregatedReturn() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ ClosingMarketValue

◆ CompositeMembers

◆ CompositeMembersWithoutReturn

◆ EffectiveAt

◆ EndOfPeriod

◆ Frequency

◆ MetricsValue

◆ OpeningMarketValue

◆ Warnings