Class Instrument

Encapsulates a tradable instrument for an Exchange

Inheritance

Object

Instrument

Implements

IComparable<Instrument>

Inherited Members

Object.Equals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Namespace: tt_net_sdk

Assembly: tt-net-api.dll

Syntax

public class Instrument : IComparable<Instrument>

Remarks

An Instrument object represents a tradable contract on an Exchange, including exchange-traded outright contracts (e.g., futures, options, bonds) and exchange-traded strategies (e.g., calendar spread, straddles).

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
Nullable<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
Nullable<Date>

Name

Declaration

public string Name { get; }

Property Value

Type	Description
String

Product

Declaration

public Product Product { get; }

Property Value

Type	Description
Product

Strike

Declaration

public decimal? Strike { get; }

Property Value

Type	Description
Nullable<Decimal>

Methods

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

System.Object.Equals(System.Object)

Equals(Instrument)

Declaration

public bool Equals(Instrument rhs)

Parameters

Type	Name	Description
Instrument	rhs

Returns

Type	Description
Boolean

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
Int32

Overrides

System.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
Boolean

IsNullOrEmpty(Instrument)

Declaration

public static bool IsNullOrEmpty(Instrument i)

Parameters

Type	Name	Description
Instrument	i

Returns

Type	Description
Boolean

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

System.Object.ToString()

Explicit Interface Implementations

IComparable<Instrument>.CompareTo(Instrument)

Declaration

int IComparable<Instrument>.CompareTo(Instrument other)

Parameters

Type	Name	Description
Instrument	other

Returns

Type	Description
Int32

Implements

System.IComparable<T>