Interface NozzleModel

The NozzleModel provides the availability of pourables that are associated with the nozzle.

Its primary purpose is to provide a mechanism for selecting from available pourables and initiating a pour.

It is possible for a dispenser to have multiple asymmetrical nozzles. For example, a dispenser may have a nozzle that is used for dispensing a syrups and flavors and another that is just dispensing water.

The NozzleModel is a IKosDataModel and is registered with the model registry using the Nozzle type.

See

Lifecycle

Load

During the load phase of the model lifecycle, the set of Availability nodes will be retrieved for the nozzle. The nodes will be indexed based on the defined groupId for the node. The groupId is defined in the dispenser beverage graph and is used to group availability nodes.

Extension Points

The load lifecycle hook will first call into the ExtensionType.AvailabilityLoader extension point in order to establish the context that will be used to populate the availability nodes.

The load lifecycle hook will then call into the ExtensionType.AvailabilityMapper for each Availability node that is retrieved. The extension point will be called the the Availability context data and the NozzleServices.BeverageResponse for the availability node.

interface NozzleModel {
    id: string;
    setSelectedBrand(brand?): void;
    setSelectedPourable(pourable): Promise<void>;
    getGroupAvailabilityItems<D>(groupId): AvailabilityModel<D>[];
    getAvailabilityByParent<D>(parentId): AvailabilityModel<D>[];
    pour(tracker?): Promise<void>;
    fixedPour(name, tracker?): Promise<void>;
    cancelPour(): Promise<void>;
}

Properties

id

Methods

setSelectedBrand setSelectedPourable getGroupAvailabilityItems getAvailabilityByParent pour fixedPour cancelPour

Properties

id

id: string

the unique identifier for this nozzle.

Methods

setSelectedBrand

  • setSelectedBrand(brand?): void

  • -------------------LIFECYCLE----------------------------

    Parameters

    Returns void

setSelectedPourable

  • setSelectedPourable(pourable): Promise<void>

  • Set the values used to determine the selected pourable for this nozzle.

    Parameters

    Returns Promise<void>

getGroupAvailabilityItems

  • getGroupAvailabilityItems<D>(groupId): AvailabilityModel<D>[]

  • Utility method that will return the availability nodes that belong to the specified group as defined in the dispenser beverage graph. For example, a dispenser implementation may group availability nodes by Brand, Beverage, or Flavors

    Type Parameters

    • D extends object = any

    Parameters

    • groupId: string

      The group to filter by.

    Returns AvailabilityModel<D>[]

    The availability nodes that are available to be dispensed from this nozzle and are in the specified group.

getAvailabilityByParent

  • getAvailabilityByParent<D>(parentId): AvailabilityModel<D>[]

  • Utility method that will return the availability nodes that are tagged with the specified parent id.

    This is useful when brandsets use the taggedIds property to associate nodes with a parent node. For example, when organizing a brandset into brands and beverages, the brand nodes will be tagged with the beverage nodes.

    Type Parameters

    • D extends object = any

    Parameters

    • parentId: string

      The parent id to filter by.

    Returns AvailabilityModel<D>[]

    the availability nodes that are tagged with the specified parent id.

pour

  • pour(tracker?): Promise<void>

  • An action that will initiate a pour for this nozzle.

    The invocation of this action will result in a Future being returned that will provide the status of the pour and return any errors that may occur.

    Parameters

    • Optional tracker: string

    Returns Promise<void>

    See

    kosFuture

fixedPour

  • fixedPour(name, tracker?): Promise<void>

  • An action that will initiate a fixed volume pour for this nozzle using the specified pourable volume name.

    The invocation of this action will result in a Future being returned that will provide the status of the pour and return any errors that may occur.

    Parameters

    • name: string
    • Optional tracker: string

    Returns Promise<void>

    See

    kosFuture

cancelPour

  • cancelPour(): Promise<void>

  • An action that will cancel a pour for this nozzle.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

idsetSelectedBrandsetSelectedPourablegetGroupAvailabilityItemsgetAvailabilityByParentpourfixedPourcancelPour