Options
All
  • Public
  • Public/Protected
  • All
Menu

A collection of utility functions when interacting with a PositionBundle.

Hierarchy

  • PositionBundleUtil

Index

Methods

  • checkBundleIndexInBounds(bundleIndex: number): boolean
  • Check if the bundle index is in the correct range.

    Parameters

    • bundleIndex: number

      The bundle index to be checked

    Returns boolean

    true if bundle index is in the correct range

  • Convert position bitmap to the array of boolean which represent if Bundled Position is open.

    Parameters

    Returns boolean[]

    The array of boolean representing if Bundled Position is open

  • Get all bundle indexes where the corresponding Bundled Position is open.

    Parameters

    Returns number[]

    The array of bundle index where the corresponding Bundled Position is open

  • Get all bundle indexes where the corresponding Bundled Position is not open.

    Parameters

    Returns number[]

    The array of bundle index where the corresponding Bundled Position is not open

  • Check if the Bundled Position corresponding to the bundle index has been opened.

    Parameters

    • positionBundle: PositionBundleData

      The position bundle to be checked

    • bundleIndex: number

      The bundle index to be checked

    Returns boolean

    true if Bundled Position has been opened

  • Check if the Bundled Position corresponding to the bundle index has not been opened.

    Parameters

    • positionBundle: PositionBundleData

      The position bundle to be checked

    • bundleIndex: number

      The bundle index to be checked

    Returns boolean

    true if Bundled Position has not been opened

Generated using TypeDoc