Lusid.Sdk.Model.PerformanceReturn Class Reference

A list of Returns. More...

Inheritance diagram for Lusid.Sdk.Model.PerformanceReturn:

Public Member Functions
	PerformanceReturn (DateTimeOffset effectiveAt=default(DateTimeOffset), decimal rateOfReturn=default(decimal), decimal? openingMarketValue=default(decimal?), decimal? closingMarketValue=default(decimal?), string period=default(string))
	Initializes a new instance of the PerformanceReturn 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 (PerformanceReturn input)
	Returns true if PerformanceReturn instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...

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

Properties
DateTimeOffset	EffectiveAt [get, set]
	The effectiveAt for the return. 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...
string	Period [get, set]
	Upsert the returns on a Daily or Monthly period. Defaults to Daily. More...

Detailed Description

A list of Returns.

Constructor & Destructor Documentation

PerformanceReturn() [1/2]

Lusid.Sdk.Model.PerformanceReturn.PerformanceReturn ( )

inlineprotected

Initializes a new instance of the PerformanceReturn class.

PerformanceReturn() [2/2]

Lusid.Sdk.Model.PerformanceReturn.PerformanceReturn ( DateTimeOffset  effectiveAt = default(DateTimeOffset), decimal  rateOfReturn = default(decimal), decimal?  openingMarketValue = default(decimal?), decimal?  closingMarketValue = default(decimal?), string  period = default(string)  )

inline

Initializes a new instance of the PerformanceReturn class.

Parameters

effectiveAt	The effectiveAt for the return. (required).
rateOfReturn	The return number. (required).
openingMarketValue	The opening market value..
closingMarketValue	The closing market value..
period	Upsert the returns on a Daily or Monthly period. Defaults to Daily..

Member Function Documentation

Equals() [1/2]

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

inline

Returns true if PerformanceReturn instances are equal

Parameters

input

Instance of PerformanceReturn to be compared

Returns

Boolean

GetHashCode()

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

inline

Gets the hash code

Returns

Hash code

ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

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

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

ClosingMarketValue

decimal? Lusid.Sdk.Model.PerformanceReturn.ClosingMarketValue

getset

The closing market value.

The closing market value.

EffectiveAt

DateTimeOffset Lusid.Sdk.Model.PerformanceReturn.EffectiveAt

getset

The effectiveAt for the return.

The effectiveAt for the return.

OpeningMarketValue

decimal? Lusid.Sdk.Model.PerformanceReturn.OpeningMarketValue

getset

The opening market value.

The opening market value.

Period

string Lusid.Sdk.Model.PerformanceReturn.Period

getset

Upsert the returns on a Daily or Monthly period. Defaults to Daily.

Upsert the returns on a Daily or Monthly period. Defaults to Daily.

RateOfReturn

decimal Lusid.Sdk.Model.PerformanceReturn.RateOfReturn

getset

The return number.

The return number.

---

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