Show / Hide Table of Contents

Class Instrument

Inheritance
object
Instrument
Implements
IComparable<Instrument>
Inherited Members
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetType()
object.MemberwiseClone()
Namespace: tt_net_sdk
Assembly: tt-net-api.dll
Syntax
public class Instrument : IComparable<Instrument>

Fields

Empty

Represents an invalid instrument

Declaration
public static readonly Instrument Empty
Field Value
Type Description
Instrument

Properties

CouponRate

Declaration
public decimal? CouponRate { get; }
Property Value
Type Description
decimal?

InstrumentDetails

Declaration
public InstrumentDetails InstrumentDetails { get; }
Property Value
Type Description
InstrumentDetails

Key

Declaration
public InstrumentKey Key { get; }
Property Value
Type Description
InstrumentKey

MaturityDate

Declaration
public Date? MaturityDate { get; }
Property Value
Type Description
Date?

Name

Declaration
public string Name { get; }
Property Value
Type Description
string

Product

Declaration
public Product Product { get; }
Property Value
Type Description
Product

Strike

Returns the strike price of the option instrument as determined by the characteristics of the underlier by applying the underlier's display factor to the instrument details StrikePrice property. Returns null when there is no strike or underlier.

Declaration
public decimal? Strike { get; }
Property Value
Type Description
decimal?

StrikeStr

Returns the strike string as received directly from the exchange. If no strike string field was received and uploaded into the product database, will return an empty string. This property returns the same value as InstrumentDetails.StrikeStr.

Declaration
public string StrikeStr { get; }
Property Value
Type Description
string

Methods

Equals(object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
object.Equals(object)

Equals(Instrument)

Declaration
public bool Equals(Instrument rhs)
Parameters
Type Name Description
Instrument rhs
Returns
Type Description
bool

GetFormattedName(InstrumentNameFormat)

Declaration
public string GetFormattedName(InstrumentNameFormat format)
Parameters
Type Name Description
InstrumentNameFormat format
Returns
Type Description
string

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()

GetLegs()

Declaration
public LegList GetLegs()
Returns
Type Description
LegList

GetSpreadDetails()

Declaration
public SpreadDetails GetSpreadDetails()
Returns
Type Description
SpreadDetails

IsEmpty()

Declaration
public bool IsEmpty()
Returns
Type Description
bool

IsNullOrEmpty(Instrument)

Declaration
public static bool IsNullOrEmpty(Instrument i)
Parameters
Type Name Description
Instrument i
Returns
Type Description
bool

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()

Implements

IComparable<T>
In this article
Back to top