LUSID representation of an Equity. More...

Inheritance diagram for Lusid.Sdk.Model.Equity:

[legend]

Public Member Functions
	Equity (EquityAllOfIdentifiers identifiers=default(EquityAllOfIdentifiers), string domCcy=default(string), int lotSize=default(int), TimeZoneConventions timeZoneConventions=default(TimeZoneConventions), TradingConventions tradingConventions=default(TradingConventions), InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
	Initializes a new instance of the Equity class. More...

override string	ToString ()
	Returns the string presentation of the object More...

override 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 (Equity input)
	Returns true if Equity instances are equal More...

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

Public Member Functions inherited from Lusid.Sdk.Model.LusidInstrument
	LusidInstrument (InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
	Initializes a new instance of the LusidInstrument class. More...

override string	ToString ()
	Returns the string presentation of the object More...

override bool	Equals (object input)
	Returns true if objects are equal More...

bool	Equals (LusidInstrument input)
	Returns true if LusidInstrument instances are equal More...

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

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

IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult >	BaseValidate (ValidationContext validationContext)
	To validate all properties of the instance More...

Protected Member Functions inherited from Lusid.Sdk.Model.LusidInstrument
	LusidInstrument ()
	Initializes a new instance of the LusidInstrument class. More...

IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult >	BaseValidate (ValidationContext validationContext)
	To validate all properties of the instance More...

Properties
EquityAllOfIdentifiers	Identifiers `[get, set]`
	Gets or Sets Identifiers More...

string	DomCcy `[get, set]`
	The domestic currency of the instrument. More...

int	LotSize `[get, set]`
	Deprecated: Use TradingConventions field instead Equity LotSize, the minimum number of shares that can be bought at once. Optional, if set must be non-negative, if not set defaults to 1. Note this property does not impact valuation. From a LUSID analytics perspective, it is purely informational. More...

TimeZoneConventions	TimeZoneConventions `[get, set]`
	Gets or Sets TimeZoneConventions More...

TradingConventions	TradingConventions `[get, set]`
	Gets or Sets TradingConventions More...

Properties inherited from Lusid.Sdk.Model.LusidInstrument
InstrumentTypeEnum	InstrumentType `[get, set]`
	Available values: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility, FlexibleDeposit, FlexibleRepo. More...

Additional Inherited Members
Public Types inherited from Lusid.Sdk.Model.LusidInstrument
enum class	InstrumentTypeEnum { QuotedSecurity = 1 , InterestRateSwap = 2 , FxForward = 3 , Future = 4 , ExoticInstrument = 5 , FxOption = 6 , CreditDefaultSwap = 7 , InterestRateSwaption = 8 , Bond = 9 , EquityOption = 10 , FixedLeg = 11 , FloatingLeg = 12 , BespokeCashFlowsLeg = 13 , Unknown = 14 , TermDeposit = 15 , ContractForDifference = 16 , EquitySwap = 17 , CashPerpetual = 18 , CapFloor = 19 , CashSettled = 20 , CdsIndex = 21 , Basket = 22 , FundingLeg = 23 , FxSwap = 24 , ForwardRateAgreement = 25 , SimpleInstrument = 26 , Repo = 27 , Equity = 28 , ExchangeTradedOption = 29 , ReferenceInstrument = 30 , ComplexBond = 31 , InflationLinkedBond = 32 , InflationSwap = 33 , SimpleCashFlowLoan = 34 , TotalReturnSwap = 35 , InflationLeg = 36 , FundShareClass = 37 , FlexibleLoan = 38 , UnsettledCash = 39 , Cash = 40 , MasteredInstrument = 41 , LoanFacility = 42 , FlexibleDeposit = 43 , FlexibleRepo = 44 }
	Available values: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility, FlexibleDeposit, FlexibleRepo. More...

Detailed Description

LUSID representation of an Equity.

Constructor & Destructor Documentation

◆ Equity() [1/2]

Lusid.Sdk.Model.Equity.Equity ( )

inlineprotected

Initializes a new instance of the Equity class.

◆ Equity() [2/2]

Lusid.Sdk.Model.Equity.Equity	(	EquityAllOfIdentifiers	identifiers = `default(EquityAllOfIdentifiers)`,
		string	domCcy = `default(string)`,
		int	lotSize = `default(int)`,
		TimeZoneConventions	timeZoneConventions = `default(TimeZoneConventions)`,
		TradingConventions	tradingConventions = `default(TradingConventions)`,
		InstrumentTypeEnum	instrumentType = `default(InstrumentTypeEnum)`
	)

inline

Initializes a new instance of the Equity class.

Parameters

identifiers	identifiers.
domCcy	The domestic currency of the instrument. (required).
lotSize	Deprecated: Use TradingConventions field instead Equity LotSize, the minimum number of shares that can be bought at once. Optional, if set must be non-negative, if not set defaults to 1. Note this property does not impact valuation. From a LUSID analytics perspective, it is purely informational..
timeZoneConventions	timeZoneConventions.
tradingConventions	tradingConventions.
instrumentType	Available values: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility, FlexibleDeposit, FlexibleRepo. (required) (default to "Equity").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.Equity.BaseValidate ( ValidationContext validationContext )

inlineprotected

To validate all properties of the instance

Parameters

validationContext Validation context

Returns: Validation Result

◆ Equals() [1/2]

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

inline

Returns true if Equity instances are equal

Parameters

input Instance of Equity to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

override string Lusid.Sdk.Model.Equity.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.LusidInstrument.

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ DomCcy

string Lusid.Sdk.Model.Equity.DomCcy

getset

The domestic currency of the instrument.

◆ Identifiers

EquityAllOfIdentifiers Lusid.Sdk.Model.Equity.Identifiers

getset

Gets or Sets Identifiers

◆ LotSize

int Lusid.Sdk.Model.Equity.LotSize

getset

Deprecated: Use TradingConventions field instead Equity LotSize, the minimum number of shares that can be bought at once. Optional, if set must be non-negative, if not set defaults to 1. Note this property does not impact valuation. From a LUSID analytics perspective, it is purely informational.

◆ TimeZoneConventions

TimeZoneConventions Lusid.Sdk.Model.Equity.TimeZoneConventions

getset

Gets or Sets TimeZoneConventions

◆ TradingConventions

TradingConventions Lusid.Sdk.Model.Equity.TradingConventions

getset

Gets or Sets TradingConventions

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

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Equity() [1/2]

◆ Equity() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ DomCcy

◆ Identifiers

◆ LotSize

◆ TimeZoneConventions

◆ TradingConventions