Class PositionBundleUtil

A collection of utility functions when interacting with a PositionBundle.

Index

Methods

checkBundleIndexInBounds convertBitmapToArray findUnoccupiedBundleIndex getOccupiedBundleIndexes getUnoccupiedBundleIndexes isEmpty isFull isOccupied isUnoccupied

Methods

`Static` checkBundleIndexInBounds

checkBundleIndexInBounds(bundleIndex): 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
- Defined in utils/public/position-bundle-util.ts:17

`Static` convertBitmapToArray

convertBitmapToArray(positionBundle): boolean[]
Convert position bitmap to the array of boolean which represent if Bundled Position is open.
Parameters
- positionBundle: PositionBundleData
  The position bundle whose bitmap will be converted
Returns boolean[]
The array of boolean representing if Bundled Position is open
- Defined in utils/public/position-bundle-util.ts:116

`Static` findUnoccupiedBundleIndex

findUnoccupiedBundleIndex(positionBundle): null | number
Get the first unoccupied bundle index in the position bundle.
Parameters
- positionBundle: PositionBundleData
  The position bundle to be checked
Returns null | number
The first unoccupied bundle index, null if the position bundle is full
- Defined in utils/public/position-bundle-util.ts:105

`Static` getOccupiedBundleIndexes

getOccupiedBundleIndexes(positionBundle): number[]
Get all bundle indexes where the corresponding Bundled Position is open.
Parameters
- positionBundle: PositionBundleData
  The position bundle to be checked
Returns number[]
The array of bundle index where the corresponding Bundled Position is open
- Defined in utils/public/position-bundle-util.ts:73

`Static` getUnoccupiedBundleIndexes

getUnoccupiedBundleIndexes(positionBundle): number[]
Get all bundle indexes where the corresponding Bundled Position is not open.
Parameters
- positionBundle: PositionBundleData
  The position bundle to be checked
Returns number[]
The array of bundle index where the corresponding Bundled Position is not open
- Defined in utils/public/position-bundle-util.ts:89

`Static` isEmpty

isEmpty(positionBundle): boolean
Check if all bundle index is unoccupied.
Parameters
- positionBundle: PositionBundleData
  The position bundle to be checked
Returns boolean
true if all bundle index is unoccupied
- Defined in utils/public/position-bundle-util.ts:62

`Static` isFull

isFull(positionBundle): boolean
Check if all bundle index is occupied.
Parameters
- positionBundle: PositionBundleData
  The position bundle to be checked
Returns boolean
true if all bundle index is occupied
- Defined in utils/public/position-bundle-util.ts:51

`Static` isOccupied

isOccupied(positionBundle, bundleIndex): boolean
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
- Defined in utils/public/position-bundle-util.ts:28

`Static` isUnoccupied

isUnoccupied(positionBundle, bundleIndex): boolean
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
- Defined in utils/public/position-bundle-util.ts:41

Generated using TypeDoc