LUSID C# SDK
Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.RealisedGainLoss Class Reference

RealisedGainLoss More...

Inheritance diagram for Lusid.Sdk.Model.RealisedGainLoss:
Inheritance graph
[legend]

Public Member Functions

 RealisedGainLoss (string instrumentScope=default(string), string instrumentUid=default(string), decimal units=default(decimal), decimal? purchasePrice=default(decimal?), CurrencyAndAmount costTradeCcy=default(CurrencyAndAmount), CurrencyAndAmount costPortfolioCcy=default(CurrencyAndAmount), CurrencyAndAmount realisedTradeCcy=default(CurrencyAndAmount), CurrencyAndAmount realisedTotal=default(CurrencyAndAmount), CurrencyAndAmount realisedMarket=default(CurrencyAndAmount), CurrencyAndAmount realisedCurrency=default(CurrencyAndAmount))
 Initializes a new instance of the RealisedGainLoss class. More...
 
bool ShouldSerializePurchaseTradeDate ()
 Returns false as PurchaseTradeDate should not be serialized given that it's read-only. More...
 
bool ShouldSerializePurchaseSettlementDate ()
 Returns false as PurchaseSettlementDate should not be serialized given that it's read-only. 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 (RealisedGainLoss input)
 Returns true if RealisedGainLoss instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 RealisedGainLoss ()
 Initializes a new instance of the RealisedGainLoss class. More...
 

Properties

string InstrumentScope [get, set]
 The scope in which the instrument lies. More...
 
string InstrumentUid [get, set]
 The unique Lusid Instrument Id (LUID) of the instrument that this gain or loss is associated with. More...
 
decimal Units [get, set]
 The number of units of the associated instrument against which the gain or loss has been realised. More...
 
DateTimeOffset? PurchaseTradeDate [get]
 The effective datetime that the units associated with this gain or loss where originally purchased. More...
 
DateTimeOffset? PurchaseSettlementDate [get]
 The effective datetime that the units associated with this gain or loss where originally settled. More...
 
decimal? PurchasePrice [get, set]
 The purchase price of each unit associated with this gain or loss. More...
 
CurrencyAndAmount CostTradeCcy [get, set]
 Gets or Sets CostTradeCcy More...
 
CurrencyAndAmount CostPortfolioCcy [get, set]
 Gets or Sets CostPortfolioCcy More...
 
CurrencyAndAmount RealisedTradeCcy [get, set]
 Gets or Sets RealisedTradeCcy More...
 
CurrencyAndAmount RealisedTotal [get, set]
 Gets or Sets RealisedTotal More...
 
CurrencyAndAmount RealisedMarket [get, set]
 Gets or Sets RealisedMarket More...
 
CurrencyAndAmount RealisedCurrency [get, set]
 Gets or Sets RealisedCurrency More...
 

Detailed Description

RealisedGainLoss

Constructor & Destructor Documentation

◆ RealisedGainLoss() [1/2]

Lusid.Sdk.Model.RealisedGainLoss.RealisedGainLoss ( )
inlineprotected

Initializes a new instance of the RealisedGainLoss class.

◆ RealisedGainLoss() [2/2]

Lusid.Sdk.Model.RealisedGainLoss.RealisedGainLoss ( string  instrumentScope = default(string),
string  instrumentUid = default(string),
decimal  units = default(decimal),
decimal?  purchasePrice = default(decimal?),
CurrencyAndAmount  costTradeCcy = default(CurrencyAndAmount),
CurrencyAndAmount  costPortfolioCcy = default(CurrencyAndAmount),
CurrencyAndAmount  realisedTradeCcy = default(CurrencyAndAmount),
CurrencyAndAmount  realisedTotal = default(CurrencyAndAmount),
CurrencyAndAmount  realisedMarket = default(CurrencyAndAmount),
CurrencyAndAmount  realisedCurrency = default(CurrencyAndAmount) 
)
inline

Initializes a new instance of the RealisedGainLoss class.

Parameters
instrumentScopeThe scope in which the instrument lies..
instrumentUidThe unique Lusid Instrument Id (LUID) of the instrument that this gain or loss is associated with. (required).
unitsThe number of units of the associated instrument against which the gain or loss has been realised. (required).
purchasePriceThe purchase price of each unit associated with this gain or loss..
costTradeCcycostTradeCcy (required).
costPortfolioCcycostPortfolioCcy (required).
realisedTradeCcyrealisedTradeCcy (required).
realisedTotalrealisedTotal (required).
realisedMarketrealisedMarket.
realisedCurrencyrealisedCurrency.

Member Function Documentation

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.RealisedGainLoss.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool Lusid.Sdk.Model.RealisedGainLoss.Equals ( RealisedGainLoss  input)
inline

Returns true if RealisedGainLoss instances are equal

Parameters
inputInstance of RealisedGainLoss to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.RealisedGainLoss.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ShouldSerializePurchaseSettlementDate()

bool Lusid.Sdk.Model.RealisedGainLoss.ShouldSerializePurchaseSettlementDate ( )
inline

Returns false as PurchaseSettlementDate should not be serialized given that it's read-only.

Returns
false (boolean)

◆ ShouldSerializePurchaseTradeDate()

bool Lusid.Sdk.Model.RealisedGainLoss.ShouldSerializePurchaseTradeDate ( )
inline

Returns false as PurchaseTradeDate should not be serialized given that it's read-only.

Returns
false (boolean)

◆ ToJson()

virtual string Lusid.Sdk.Model.RealisedGainLoss.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.RealisedGainLoss.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ CostPortfolioCcy

CurrencyAndAmount Lusid.Sdk.Model.RealisedGainLoss.CostPortfolioCcy
getset

Gets or Sets CostPortfolioCcy

◆ CostTradeCcy

CurrencyAndAmount Lusid.Sdk.Model.RealisedGainLoss.CostTradeCcy
getset

Gets or Sets CostTradeCcy

◆ InstrumentScope

string Lusid.Sdk.Model.RealisedGainLoss.InstrumentScope
getset

The scope in which the instrument lies.

The scope in which the instrument lies.

◆ InstrumentUid

string Lusid.Sdk.Model.RealisedGainLoss.InstrumentUid
getset

The unique Lusid Instrument Id (LUID) of the instrument that this gain or loss is associated with.

The unique Lusid Instrument Id (LUID) of the instrument that this gain or loss is associated with.

◆ PurchasePrice

decimal? Lusid.Sdk.Model.RealisedGainLoss.PurchasePrice
getset

The purchase price of each unit associated with this gain or loss.

The purchase price of each unit associated with this gain or loss.

◆ PurchaseSettlementDate

DateTimeOffset? Lusid.Sdk.Model.RealisedGainLoss.PurchaseSettlementDate
get

The effective datetime that the units associated with this gain or loss where originally settled.

The effective datetime that the units associated with this gain or loss where originally settled.

◆ PurchaseTradeDate

DateTimeOffset? Lusid.Sdk.Model.RealisedGainLoss.PurchaseTradeDate
get

The effective datetime that the units associated with this gain or loss where originally purchased.

The effective datetime that the units associated with this gain or loss where originally purchased.

◆ RealisedCurrency

CurrencyAndAmount Lusid.Sdk.Model.RealisedGainLoss.RealisedCurrency
getset

Gets or Sets RealisedCurrency

◆ RealisedMarket

CurrencyAndAmount Lusid.Sdk.Model.RealisedGainLoss.RealisedMarket
getset

Gets or Sets RealisedMarket

◆ RealisedTotal

CurrencyAndAmount Lusid.Sdk.Model.RealisedGainLoss.RealisedTotal
getset

Gets or Sets RealisedTotal

◆ RealisedTradeCcy

CurrencyAndAmount Lusid.Sdk.Model.RealisedGainLoss.RealisedTradeCcy
getset

Gets or Sets RealisedTradeCcy

◆ Units

decimal Lusid.Sdk.Model.RealisedGainLoss.Units
getset

The number of units of the associated instrument against which the gain or loss has been realised.

The number of units of the associated instrument against which the gain or loss has been realised.


The documentation for this class was generated from the following file: