Interface AssemblyModel<AssemblyExt, HolderExt>

Represents the union of device assemblies including all of the boards, holders, pumps and nozzles defined on the device.

interface AssemblyModel<AssemblyExt, HolderExt> {
    holderGroups: string[];
    nozzlePaths: string[];
    allHolders: HolderModel<HolderExt>[];
    getHoldersByGroup(group): HolderModel<HolderExt>[];
    getHoldersByNozzle(nozzlePath): HolderModel<HolderExt>[];
    pumpsByNozzle: Record<string, PumpModel<any>[]>;
    pumpPaths: string[];
}

Type Parameters

  • AssemblyExt extends object = any
  • HolderExt extends object = any

Hierarchy (view full)

Properties

holderGroups nozzlePaths allHolders pumpsByNozzle pumpPaths

Methods

getHoldersByGroup getHoldersByNozzle

Properties

Readonly holderGroups

holderGroups: string[]

The unique list of holder group names

Readonly nozzlePaths

nozzlePaths: string[]

The list of all nozzle paths defined on the device. This is useful as a means to discover which nozzles are available on dispensers with multiple nozzles.

Readonly allHolders

allHolders: HolderModel<HolderExt>[]

The list of all holders defined on the device, regardless of group

Readonly pumpsByNozzle

pumpsByNozzle: Record<string, PumpModel<any>[]>

Returns a map of the pumps associated with each nozzle

Can be used in conjunction with the nozzlePaths to get the pumps associated with each nozzle

Readonly pumpPaths

pumpPaths: string[]

Returns a list of all fo the pumps paths across the entire assembly.

Methods

getHoldersByGroup

getHoldersByNozzle

  • getHoldersByNozzle(nozzlePath): HolderModel<HolderExt>[]

  • Get the holders mapped to a given nozzle.

    Parameters

    • nozzlePath: string

      the nozzle path to filter the holders by.

    Returns HolderModel<HolderExt>[]

Settings

Member Visibility

Theme

On This Page

holderGroupsnozzlePathsallHolderspumpsByNozzlepumpPathsgetHoldersByGroupgetHoldersByNozzle