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

Specification for a holding or quantity of (weight for) an instrument on a given date. More...

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

Public Member Functions

 WeightedInstrument (decimal quantity=default(decimal), string holdingIdentifier=default(string), LusidInstrument instrument=default(LusidInstrument), WeightedInstrumentInLineLookupIdentifiers inLineLookupIdentifiers=default(WeightedInstrumentInLineLookupIdentifiers))
 Initializes a new instance of the WeightedInstrument 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 (WeightedInstrument input)
 Returns true if WeightedInstrument instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Properties

decimal Quantity [get, set]
 The quantity of the instrument that is owned. More...
 
string HoldingIdentifier [get, set]
 Identifier for the instrument. For a single, unique trade or transaction this can be thought of as equivalent to the transaction identifier, or a composite of the sub-holding keys for a regular sub-holding. When there are multiple transactions sharing the same underlying instrument such as purchase of shares on multiple dates where tax implications are different this would not be the case. In an inlined aggregation request if this is wanted to identify a line item, it can be specified in the set of aggregation keys given on the aggregation request that accompanies the set of weighted instruments. More...
 
LusidInstrument Instrument [get, set]
 Gets or Sets Instrument More...
 
WeightedInstrumentInLineLookupIdentifiers InLineLookupIdentifiers [get, set]
 Gets or Sets InLineLookupIdentifiers More...
 

Detailed Description

Specification for a holding or quantity of (weight for) an instrument on a given date.

Constructor & Destructor Documentation

◆ WeightedInstrument()

Lusid.Sdk.Model.WeightedInstrument.WeightedInstrument ( decimal  quantity = default(decimal),
string  holdingIdentifier = default(string),
LusidInstrument  instrument = default(LusidInstrument),
WeightedInstrumentInLineLookupIdentifiers  inLineLookupIdentifiers = default(WeightedInstrumentInLineLookupIdentifiers) 
)
inline

Initializes a new instance of the WeightedInstrument class.

Parameters
quantityThe quantity of the instrument that is owned..
holdingIdentifierIdentifier for the instrument. For a single, unique trade or transaction this can be thought of as equivalent to the transaction identifier, or a composite of the sub-holding keys for a regular sub-holding. When there are multiple transactions sharing the same underlying instrument such as purchase of shares on multiple dates where tax implications are different this would not be the case. In an inlined aggregation request if this is wanted to identify a line item, it can be specified in the set of aggregation keys given on the aggregation request that accompanies the set of weighted instruments..
instrumentinstrument.
inLineLookupIdentifiersinLineLookupIdentifiers.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if WeightedInstrument instances are equal

Parameters
inputInstance of WeightedInstrument to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ HoldingIdentifier

string Lusid.Sdk.Model.WeightedInstrument.HoldingIdentifier
getset

Identifier for the instrument. For a single, unique trade or transaction this can be thought of as equivalent to the transaction identifier, or a composite of the sub-holding keys for a regular sub-holding. When there are multiple transactions sharing the same underlying instrument such as purchase of shares on multiple dates where tax implications are different this would not be the case. In an inlined aggregation request if this is wanted to identify a line item, it can be specified in the set of aggregation keys given on the aggregation request that accompanies the set of weighted instruments.

Identifier for the instrument. For a single, unique trade or transaction this can be thought of as equivalent to the transaction identifier, or a composite of the sub-holding keys for a regular sub-holding. When there are multiple transactions sharing the same underlying instrument such as purchase of shares on multiple dates where tax implications are different this would not be the case. In an inlined aggregation request if this is wanted to identify a line item, it can be specified in the set of aggregation keys given on the aggregation request that accompanies the set of weighted instruments.

◆ InLineLookupIdentifiers

WeightedInstrumentInLineLookupIdentifiers Lusid.Sdk.Model.WeightedInstrument.InLineLookupIdentifiers
getset

Gets or Sets InLineLookupIdentifiers

◆ Instrument

LusidInstrument Lusid.Sdk.Model.WeightedInstrument.Instrument
getset

Gets or Sets Instrument

◆ Quantity

decimal Lusid.Sdk.Model.WeightedInstrument.Quantity
getset

The quantity of the instrument that is owned.

The quantity of the instrument that is owned.


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