Represents context information of a node, edge, or instant action to be processed by an executeAction, finishEdgeAction, or cancelAction handler.

Hierarchy

  • ActionContext

Properties

action: Action

The context's action.

activeOrderId?: string

Specifies the orderId of an order's node or edge action; the active orderId for instant actions if one is currently active; otherwise this property is not defined.

edge?: Edge

Specifies the edge if the context's action is an edge action; otherwise this property is not defined.

edgeEndNode?: Node

Specifies the end node of the edge if the context's action is an edge action; otherwise this property is not defined.

edgeStartNode?: Node

Specifies the start node of the edge if the context's action is an edge action; otherwise this property is not defined.

node?: Node

Specifies the node if the context's action is a node action; otherwise this property is not defined.

Defines whether the context's action is an instant, node, or edge action.

stopDriving?: boolean

Determines whether the AGV must stop driving before executing the action (optional, only specified in the context of an executeAction handler).

If specified as true driving must be stopped; if false the AGV must keep its current driving state.

Remarks

This parameter is not specified for finishEdgeAction, isActionExecutable, and cancelAction handlers.

Methods

  • Callback to be invoked by the AGV adapter whenever the action transitions to a new action status.

    This method should be invoked according to the progress of the action, passing in an updated action status together with the result description, error description, and linked partial state (if applicable).

    Remarks

    This parameter is not defined for the isActionExecutable handler.

    When the action transitions into status FAILED an additional error state can be reported by specifying an error description.

    Parameters

    Returns void

Generated using TypeDoc