import {v9} from 'evntscript/src/index.js'
public class |source

v9

Class used for referencing all v9 event enumerations and data

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

A v9Aggressor enumeration that contains each of the different values that may be returned from:

  • pEvent.tradeSummary.aggressor
public

A v9BookAction enumeration that contains each of the different values that may be returned from:

  • pEvent.orderBook.action
  • pEvent.bookLevel.action
public

A v9BookType enumeration that contains each of the different values that may be returned from:

  • pEvent.orderBook.type
  • pEvent.bookLevel.type
public

A v9DailyStatisticsType enumeration that contains each of the different values that may be returned from:

  • pEvent.dailyStatistics.type
public

A v9EventIndicator enumeration that contains each of the different values that may be returned from:

  • N/A
public

A v9HaltReason enumeration that contains each of the different values that may be returned from:

  • pEvent.securityStatus.haltReason
public

A v9InvestigateStatus enumeration that contains each of the different values that may be returned from:

  • N/A
public

A v9PutOrCall enumeration that contains each of the different values that may be returned from:

  • pEvent.PutOrCall.type
public

A v9SecurityEvent enumeration that contains each of the different values that may be returned from:

  • pEvent.securityStatus.securityEvent
public

A v9SecurityType enumeration that contains each of the different values that may be returned from:

  • pEvent.securityStatus.type
public

A v9SessionStatisticsType enumeration that contains each of the different values that may be returned from:

  • pEvent.sessionStatistics.type
public

A v9SettleType enumeration that contains each of the different values that may be returned from:

  • pEvent.dailyStatistics.settleType
public

A v9StateType enumeration that contains each of the different values that may be returned from:

  • pEvent.sessionStatistics.stateType
public

A v9TransactionType enumeration that contains each of the different values that may be returned from:

  • pEvent.transactionMarker.transactionType
public

A v9UnionID enumeration that contains each of the different values that may be returned from:

  • v9.UnionID
Private Members
private

Value used specify a non-existent 32 bit price returned

private

Value used specify a non-existent 64 bit price returned

Public Constructors

public constructor() source

Public Members

public Aggressor: Aggressor source

A v9Aggressor enumeration that contains each of the different values that may be returned from:

  • pEvent.tradeSummary.aggressor

Example:

onEvent(pSymbol, pEvent, pRealTime) {
    switch (pEvent.header.unionID) {
   case v9.UnionID.TradeSummary:
                 var agr = pEvent.tradeSummary.aggressor;
             break;
         default :
             break;
    }
}

public BookAction: BookAction source

A v9BookAction enumeration that contains each of the different values that may be returned from:

  • pEvent.orderBook.action
  • pEvent.bookLevel.action

Example:

onEvent(pSymbol, pEvent, pRealTime) {
    switch (pEvent.header.unionID) {
   case v9.UnionID.OrderBook:
                 var act = pEvent.orderBook.action;
             break;
         default :
             break;
    }
}

public BookType: BookType source

A v9BookType enumeration that contains each of the different values that may be returned from:

  • pEvent.orderBook.type
  • pEvent.bookLevel.type

Example:

onEvent(pSymbol, pEvent, pRealTime) {
    switch (pEvent.header.unionID) {
   case v9.UnionID.OrderBook:
                 var typ = pEvent.orderBook.type;
             break;
         default :
             break;
    }
}

public DailyStatisticsType: DailyStatisticsType source

A v9DailyStatisticsType enumeration that contains each of the different values that may be returned from:

  • pEvent.dailyStatistics.type

Example:

onEvent(pSymbol, pEvent, pRealTime) {
    switch (pEvent.header.unionID) {
   case v9.UnionID.DailyStatistics:
                 var typ = pEvent.dailyStatistics.type;
             break;
         default :
             break;
    }
}

public EventIndicator: EventIndicator source

A v9EventIndicator enumeration that contains each of the different values that may be returned from:

  • N/A

Example:

onEvent(pSymbol, pEvent, pRealTime) {
    // N/A
}

public HaltReason: HaltReason source

A v9HaltReason enumeration that contains each of the different values that may be returned from:

  • pEvent.securityStatus.haltReason

Example:

onEvent(pSymbol, pEvent, pRealTime) {
    switch (pEvent.header.unionID) {
        case v9.UnionID.SecurityStatus:
            var hlt = pEvent.securityStatus.haltReason;
            break;
        default :
            break;
    }
}

public InvestigateStatus: InvestigateStatus source

A v9InvestigateStatus enumeration that contains each of the different values that may be returned from:

  • N/A

Example:

onEvent(pSymbol, pEvent, pRealTime) {
    // N/A
}

public PutOrCall: PutOrCall source

A v9PutOrCall enumeration that contains each of the different values that may be returned from:

  • pEvent.PutOrCall.type

Example:

onEvent(pSymbol, pEvent, pRealTime) {
    // N/A
}

public SecurityEvent: SecurityEvent source

A v9SecurityEvent enumeration that contains each of the different values that may be returned from:

  • pEvent.securityStatus.securityEvent

Example:

onEvent(pSymbol, pEvent, pRealTime) {
    switch (pEvent.header.unionID) {
   case v9.UnionID.SecurityStatus:
                 var sev = pEvent.securityStatus.securityEvent;
             break;
         default :
             break;
    }
}

public SecurityType: SecurityType source

A v9SecurityType enumeration that contains each of the different values that may be returned from:

  • pEvent.securityStatus.type

Example:

onEvent(pSymbol, pEvent, pRealTime) {
    switch (pEvent.header.unionID) {
        case v9.UnionID.SecurityStatus:
            var typ = pEvent.securityStatus.type;
            break;
        default :
            break;
    }
}

public SessionStatisticsType: SessionStatisticsType source

A v9SessionStatisticsType enumeration that contains each of the different values that may be returned from:

  • pEvent.sessionStatistics.type

Example:

onEvent(pSymbol, pEvent, pRealTime) {
    switch (pEvent.header.unionID) {
        case v9.UnionID.SessionStatistics:
                 var typ = pEvent.sessionStatistics.type;
             break;
         default :
             break;
    }
}

public SettleType: SettleType source

A v9SettleType enumeration that contains each of the different values that may be returned from:

  • pEvent.dailyStatistics.settleType

Example:

onEvent(pSymbol, pEvent, pRealTime) {
    switch (pEvent.header.unionID) {
   case v9.UnionID.DailyStatistics:
                 var stl = pEvent.dailyStatistics.settleType;
             break;
         default :
             break;
    }
}

public StateType: StateType source

A v9StateType enumeration that contains each of the different values that may be returned from:

  • pEvent.sessionStatistics.stateType

Example:

onEvent(pSymbol, pEvent, pRealTime) {
    switch (pEvent.header.unionID) {
   case v9.UnionID.SessionStatistics:
                 var stt = pEvent.sessionStatistics.stateType;
             break;
         default :
             break;
    }
}

public TransactionType: TransactionType source

A v9TransactionType enumeration that contains each of the different values that may be returned from:

  • pEvent.transactionMarker.transactionType

Example:

onEvent(pSymbol, pEvent, pRealTime) {
    switch (pEvent.header.unionID) {
   case v9.UnionID.TransactionMarker:
                 var ttp = pEvent.transactionMarker.transactionType;
             break;
         default :
             break;
    }
}

public UnionID: enumeration source

A v9UnionID enumeration that contains each of the different values that may be returned from:

  • v9.UnionID

Example:

onEvent(pSymbol, pEvent, pRealTime) {
    switch (pEvent.header.unionID) {
        case v9.UnionID.<Value>:
            // Do something when pEvent.header.unionID is equal to v9.UnionID.<Value>
            break;
        default :
            break;
    }
}

Private Members

private PRICE_NULL_32: number source

Value used specify a non-existent 32 bit price returned

private PRICE_NULL_64: number source

Value used specify a non-existent 64 bit price returned