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

LUSID representation of a Simple Instrument, used as a basic definition of a generic instrument. No analytics can be obtained for this. More...

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

Public Types

enum class  AssetClassEnum {
  InterestRates = 1 , FX = 2 , Inflation = 3 , Equities = 4 ,
  Credit = 5 , Commodities = 6 , Money = 7 , Unknown = 8
}
 The available values are: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown More...
 
- 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
}
 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, TotalReturnSwap, InflationLeg, FundShareClass More...
 

Public Member Functions

 SimpleInstrument (DateTimeOffset maturityDate=default(DateTimeOffset), string domCcy=default(string), AssetClassEnum assetClass=default(AssetClassEnum), List< string > fgnCcys=default(List< string >), string simpleInstrumentType=default(string), InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
 Initializes a new instance of the SimpleInstrument 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 (SimpleInstrument input)
 Returns true if SimpleInstrument 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

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

AssetClassEnum AssetClass [get, set]
 The available values are: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown More...
 
DateTimeOffset MaturityDate [get, set]
 The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it. More...
 
string DomCcy [get, set]
 The domestic currency. More...
 
List< string > FgnCcys [get, set]
 The set of foreign currencies, if any (optional). More...
 
string SimpleInstrumentType [get, set]
 The Instrument type of the simple instrument. 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, TotalReturnSwap, InflationLeg, FundShareClass More...
 

Detailed Description

LUSID representation of a Simple Instrument, used as a basic definition of a generic instrument. No analytics can be obtained for this.

Member Enumeration Documentation

◆ AssetClassEnum

The available values are: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown

The available values are: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown

Enumerator
InterestRates 

Enum InterestRates for value: InterestRates

FX 

Enum FX for value: FX

Inflation 

Enum Inflation for value: Inflation

Equities 

Enum Equities for value: Equities

Credit 

Enum Credit for value: Credit

Commodities 

Enum Commodities for value: Commodities

Money 

Enum Money for value: Money

Unknown 

Enum Unknown for value: Unknown

Constructor & Destructor Documentation

◆ SimpleInstrument() [1/2]

Lusid.Sdk.Model.SimpleInstrument.SimpleInstrument ( )
inlineprotected

Initializes a new instance of the SimpleInstrument class.

◆ SimpleInstrument() [2/2]

Lusid.Sdk.Model.SimpleInstrument.SimpleInstrument ( DateTimeOffset  maturityDate = default(DateTimeOffset),
string  domCcy = default(string),
AssetClassEnum  assetClass = default(AssetClassEnum),
List< string >  fgnCcys = default(List<string>),
string  simpleInstrumentType = default(string),
InstrumentTypeEnum  instrumentType = default(InstrumentTypeEnum) 
)
inline

Initializes a new instance of the SimpleInstrument class.

Parameters
maturityDateThe final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it..
domCcyThe domestic currency. (required).
assetClassThe available values are: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown (required).
fgnCcysThe set of foreign currencies, if any (optional)..
simpleInstrumentTypeThe Instrument type of the simple instrument. (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, TotalReturnSwap, InflationLeg, FundShareClass (required) (default to "SimpleInstrument").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.SimpleInstrument.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.SimpleInstrument.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if SimpleInstrument instances are equal

Parameters
inputInstance of SimpleInstrument to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AssetClass

AssetClassEnum Lusid.Sdk.Model.SimpleInstrument.AssetClass
getset

The available values are: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown

The available values are: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown

◆ DomCcy

string Lusid.Sdk.Model.SimpleInstrument.DomCcy
getset

The domestic currency.

The domestic currency.

◆ FgnCcys

List<string> Lusid.Sdk.Model.SimpleInstrument.FgnCcys
getset

The set of foreign currencies, if any (optional).

The set of foreign currencies, if any (optional).

◆ MaturityDate

DateTimeOffset Lusid.Sdk.Model.SimpleInstrument.MaturityDate
getset

The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it.

The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it.

◆ SimpleInstrumentType

string Lusid.Sdk.Model.SimpleInstrument.SimpleInstrumentType
getset

The Instrument type of the simple instrument.

The Instrument type of the simple instrument.


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