Lusid.Sdk.Model.PerformanceReturnsMetric Class Reference

The request used in the AggregatedReturns. More...

Inheritance diagram for Lusid.Sdk.Model.PerformanceReturnsMetric:

Public Member Functions
	PerformanceReturnsMetric (string type=default(string), string window=default(string), bool allowPartial=default(bool), bool annualised=default(bool), bool withFee=default(bool), string seedAmount=default(string), string alias=default(string))
	Initializes a new instance of the PerformanceReturnsMetric 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 (PerformanceReturnsMetric input)
	Returns true if PerformanceReturnsMetric instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...

Properties
string	Type [get, set]
	The type of the metric. Default to Return More...
string	Window [get, set]
	The given metric for the calculation i.e. 1Y, 1D. More...
bool	AllowPartial [get, set]
	Bool if the metric is allowed partial results. Default to false. More...
bool	Annualised [get, set]
	Bool if the metric is annualized. Default to false. More...
bool	WithFee [get, set]
	Bool if the metric should consider the fees when is calculated. Default to false. More...
string	SeedAmount [get, set]
	The given seed amount for the calculation of the indicative amount metrics. More...
string	Alias [get, set]
	The alias for the metric. More...

Detailed Description

The request used in the AggregatedReturns.

Constructor & Destructor Documentation

PerformanceReturnsMetric()

Lusid.Sdk.Model.PerformanceReturnsMetric.PerformanceReturnsMetric ( string  type = default(string), string  window = default(string), bool  allowPartial = default(bool), bool  annualised = default(bool), bool  withFee = default(bool), string  seedAmount = default(string), string  alias = default(string)  )

inline

Initializes a new instance of the PerformanceReturnsMetric class.

Parameters

type	The type of the metric. Default to Return.
window	The given metric for the calculation i.e. 1Y, 1D..
allowPartial	Bool if the metric is allowed partial results. Default to false..
annualised	Bool if the metric is annualized. Default to false..
withFee	Bool if the metric should consider the fees when is calculated. Default to false..
seedAmount	The given seed amount for the calculation of the indicative amount metrics..
alias	The alias for the metric..

Member Function Documentation

Equals() [1/2]

override bool Lusid.Sdk.Model.PerformanceReturnsMetric.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.PerformanceReturnsMetric.Equals ( PerformanceReturnsMetric  input )

inline

Returns true if PerformanceReturnsMetric instances are equal

Parameters

input

Instance of PerformanceReturnsMetric to be compared

Returns

Boolean

GetHashCode()

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

inline

Gets the hash code

Returns

Hash code

ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

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

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

Alias

string Lusid.Sdk.Model.PerformanceReturnsMetric.Alias

getset

The alias for the metric.

The alias for the metric.

AllowPartial

bool Lusid.Sdk.Model.PerformanceReturnsMetric.AllowPartial

getset

Bool if the metric is allowed partial results. Default to false.

Bool if the metric is allowed partial results. Default to false.

Annualised

bool Lusid.Sdk.Model.PerformanceReturnsMetric.Annualised

getset

Bool if the metric is annualized. Default to false.

Bool if the metric is annualized. Default to false.

SeedAmount

string Lusid.Sdk.Model.PerformanceReturnsMetric.SeedAmount

getset

The given seed amount for the calculation of the indicative amount metrics.

The given seed amount for the calculation of the indicative amount metrics.

Type

string Lusid.Sdk.Model.PerformanceReturnsMetric.Type

getset

The type of the metric. Default to Return

The type of the metric. Default to Return

Window

string Lusid.Sdk.Model.PerformanceReturnsMetric.Window

getset

The given metric for the calculation i.e. 1Y, 1D.

The given metric for the calculation i.e. 1Y, 1D.

WithFee

bool Lusid.Sdk.Model.PerformanceReturnsMetric.WithFee

getset

Bool if the metric should consider the fees when is calculated. Default to false.

Bool if the metric should consider the fees when is calculated. Default to false.

---

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