Sequenced Shelf Module

Defined in package com.scandit.datacapture.barcode.sequence.data

SequencedShelfModule

class SequencedShelfModule

Added in version 8.0.0

A shelf module within a sequencing context containing organized trays.

Represents a shelf module that has been processed as part of shelf sequencing operations. This class provides access to the collection of trays that make up the shelf module, with each tray containing its own sequenced barcodes.

SequencedShelfModule()

SequencedShelfModule(planogram: List<List<BarcodeInfo>>)

Added in version 8.7.0

Creates a SequencedShelfModule from the provided list of lists of BarcodeInfo. Each list is a new tray and the list inside that are the barcodes in that tray.

trays

val trays: List<SequencedTray>

Added in version 8.0.0

The collection of sequenced trays contained within this shelf module. Each tray includes its own positional information and collection of sequenced barcodes.

fromJson(jsonData)

fun SequencedShelfModule.fromJson(jsonData: String): SequencedShelfModule?

Added in version 8.7.0

Creates a SequencedShelfModule from the provided json. Returns null if the json is invalid.

The json should have the following structure:

{
  "trays": [
    {
      "orderOnShelf": 0,
      "barcodes": [
        {
          "data": "123456789",
          "symbology": "code128",
          "orderOnTray": 0
        },
        {
          "data": "987654321",
          "symbology": "qr",
          "orderOnTray": 1
        }
      ]
    },
    {
      "orderOnShelf": 1,
      "barcodes": [
        {
          "data": "555666777",
          "symbology": "dataMatrix",
          "orderOnTray": 0
        }
      ]
    }
  ]
}

Where:

trays: An array of tray objects
orderOnShelf: The position of the tray on the shelf (0-based index)
barcodes: An array of barcode objects within each tray
data: The barcode data string
symbology: The barcode symbology identifier (e.g., “code128”, “qr”, “dataMatrix”, “ean13”)
orderOnTray: The position of the barcode on the tray (0-based index)

Positions in a verification planogram are 0-based, counted from the tray and position where the session starts, and trays lists the trays in shelf order. When reported as SequencedBarcode.expectedOrderOnShelf, every tray’s orderOnShelf is offset by BarcodeSequenceSettings.initialOrderOnShelf. When reported as SequencedBarcode.expectedOrderOnTray, BarcodeSequenceSettings.initialOrderOnTray is added only to the barcodes of the first tray in trays, the same way SequencedBarcode.orderOnTray is seeded.

toJson()

fun toJson(): String

Added in version 8.7.0

Provides a json representation of the SequencedShelfModule.