Interface VirtualActionDefinition

Defines all possible states and state transitions of a node, edge, or instant action supported by a virtual AGV.

Hierarchy

  • VirtualActionDefinition

Properties

actionExecutable? actionParameterConstraints? actionScopes actionType transitions

Properties

Optional actionExecutable

actionExecutable?: ((action: Action, scope: ActionScope, activeOrderId: string) => string)

Type declaration

    • (action: Action, scope: ActionScope, activeOrderId: string): string

    • Defines a function that is invoked to check whether a given action / scope is executable in the context of an active order, if any (optional).

      Returns an error description string if action is not executable; undefined or empty string otherwise.

      Remarks

      This check is performed immediately before the action is executed by the adapter, so it can take the current vehicle state into account.

      Parameters

      Returns string

Optional actionParameterConstraints

actionParameterConstraints?: {
    [actionParameterKey: string]: ((actionParameterValue: string | number | boolean | any[], scope: ActionScope, allActionParams: {
        [actionParameterKey: string]: string | number | boolean | any[];
    }) => boolean);
}

Defines constraint functions for action parameters (optional).

To constraint the value of a specific action parameter key-value pair, specify a function that returns true if the parameter's actual value is valid; false otherwise. If the action parameter key is not specified, undefined is passed as action parameter value to the constraint function.

An action is only executable if all the specified action parameter constraints are satified.

Type declaration

  • [actionParameterKey: string]: ((actionParameterValue: string | number | boolean | any[], scope: ActionScope, allActionParams: {
        [actionParameterKey: string]: string | number | boolean | any[];
    }) => boolean)
      • (actionParameterValue: string | number | boolean | any[], scope: ActionScope, allActionParams: {
            [actionParameterKey: string]: string | number | boolean | any[];
        }): boolean

      • Parameters

        • actionParameterValue: string | number | boolean | any[]
        • scope: ActionScope
        • allActionParams: {
              [actionParameterKey: string]: string | number | boolean | any[];
          }
          • [actionParameterKey: string]: string | number | boolean | any[]

        Returns boolean

actionScopes

actionScopes: ActionScope | ActionScope[]

Valid scopes of the action, any combination of "instant", "node", or "edge".

actionType

actionType: string

Type of action.

transitions

transitions: VirtualActionTransitions

Defines all possible states and transitions of an action.

Settings

Member Visibility

Theme

Generated using TypeDoc