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

LUSID representation of an Exchange Traded Option. Including, but not limited to, Equity Options, Bond Options, Index Options, Future Options, and Interest Rate Options. More...

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

Public Member Functions

 ExchangeTradedOption (DateTimeOffset startDate=default(DateTimeOffset), ExchangeTradedOptionContractDetails contractDetails=default(ExchangeTradedOptionContractDetails), decimal contracts=default(decimal), decimal refSpotPrice=default(decimal), InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
 Initializes a new instance of the ExchangeTradedOption 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 (ExchangeTradedOption input)
 Returns true if ExchangeTradedOption 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

 ExchangeTradedOption ()
 Initializes a new instance of the ExchangeTradedOption 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

DateTimeOffset StartDate [get, set]
 The start date of the instrument. This is normally synonymous with the trade-date. More...
 
ExchangeTradedOptionContractDetails ContractDetails [get, set]
 Gets or Sets ContractDetails More...
 
decimal Contracts [get, set]
 The number of contracts held. More...
 
decimal RefSpotPrice [get, set]
 The reference spot price for the option at which the contract was entered into. More...
 
- Properties inherited from Lusid.Sdk.Model.LusidInstrument
InstrumentTypeEnum InstrumentType [get, set]
 The available values are: 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 More...
 

Additional Inherited Members

- Public Types inherited from Lusid.Sdk.Model.LusidInstrument
enum  InstrumentTypeEnum {
  InstrumentTypeEnum.QuotedSecurity = 1, InstrumentTypeEnum.InterestRateSwap = 2, InstrumentTypeEnum.FxForward = 3, InstrumentTypeEnum.Future = 4,
  InstrumentTypeEnum.ExoticInstrument = 5, InstrumentTypeEnum.FxOption = 6, InstrumentTypeEnum.CreditDefaultSwap = 7, InstrumentTypeEnum.InterestRateSwaption = 8,
  InstrumentTypeEnum.Bond = 9, InstrumentTypeEnum.EquityOption = 10, InstrumentTypeEnum.FixedLeg = 11, InstrumentTypeEnum.FloatingLeg = 12,
  InstrumentTypeEnum.BespokeCashFlowsLeg = 13, InstrumentTypeEnum.Unknown = 14, InstrumentTypeEnum.TermDeposit = 15, InstrumentTypeEnum.ContractForDifference = 16,
  InstrumentTypeEnum.EquitySwap = 17, InstrumentTypeEnum.CashPerpetual = 18, InstrumentTypeEnum.CapFloor = 19, InstrumentTypeEnum.CashSettled = 20,
  InstrumentTypeEnum.CdsIndex = 21, InstrumentTypeEnum.Basket = 22, InstrumentTypeEnum.FundingLeg = 23, InstrumentTypeEnum.FxSwap = 24,
  InstrumentTypeEnum.ForwardRateAgreement = 25, InstrumentTypeEnum.SimpleInstrument = 26, InstrumentTypeEnum.Repo = 27, InstrumentTypeEnum.Equity = 28,
  InstrumentTypeEnum.ExchangeTradedOption = 29, InstrumentTypeEnum.ReferenceInstrument = 30, InstrumentTypeEnum.ComplexBond = 31, InstrumentTypeEnum.InflationLinkedBond = 32,
  InstrumentTypeEnum.InflationSwap = 33, InstrumentTypeEnum.SimpleCashFlowLoan = 34
}
 The available values are: 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 More...
 

Detailed Description

LUSID representation of an Exchange Traded Option. Including, but not limited to, Equity Options, Bond Options, Index Options, Future Options, and Interest Rate Options.

Constructor & Destructor Documentation

◆ ExchangeTradedOption() [1/2]

Lusid.Sdk.Model.ExchangeTradedOption.ExchangeTradedOption ( )
inlineprotected

Initializes a new instance of the ExchangeTradedOption class.

◆ ExchangeTradedOption() [2/2]

Lusid.Sdk.Model.ExchangeTradedOption.ExchangeTradedOption ( DateTimeOffset  startDate = default(DateTimeOffset),
ExchangeTradedOptionContractDetails  contractDetails = default(ExchangeTradedOptionContractDetails),
decimal  contracts = default(decimal),
decimal  refSpotPrice = default(decimal),
InstrumentTypeEnum  instrumentType = default(InstrumentTypeEnum) 
)
inline

Initializes a new instance of the ExchangeTradedOption class.

Parameters
startDateThe start date of the instrument. This is normally synonymous with the trade-date. (required).
contractDetailscontractDetails (required).
contractsThe number of contracts held. (required).
refSpotPriceThe reference spot price for the option at which the contract was entered into. (required).
instrumentTypeThe available values are: 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 (required) (default to "ExchangeTradedOption").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if ExchangeTradedOption instances are equal

Parameters
inputInstance of ExchangeTradedOption to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

override string Lusid.Sdk.Model.ExchangeTradedOption.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.ExchangeTradedOption.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ ContractDetails

ExchangeTradedOptionContractDetails Lusid.Sdk.Model.ExchangeTradedOption.ContractDetails
getset

Gets or Sets ContractDetails

◆ Contracts

decimal Lusid.Sdk.Model.ExchangeTradedOption.Contracts
getset

The number of contracts held.

The number of contracts held.

◆ RefSpotPrice

decimal Lusid.Sdk.Model.ExchangeTradedOption.RefSpotPrice
getset

The reference spot price for the option at which the contract was entered into.

The reference spot price for the option at which the contract was entered into.

◆ StartDate

DateTimeOffset Lusid.Sdk.Model.ExchangeTradedOption.StartDate
getset

The start date of the instrument. This is normally synonymous with the trade-date.

The start date of the instrument. This is normally synonymous with the trade-date.


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