Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OpcuaCallReturnMapping

Defines a one-to-one mapping from a Call-Return event operation to an OPC UA method call.

Hierarchy

  • OpcuaCallReturnMapping

Index

Properties

Optional coerceOutputArguments

coerceOutputArguments: (resultValues: any[]) => any

A coercion function that coerces the array of result (i.e. output argument) values of the OPC UA method call to the result value of the associated Return event (optional).

If not specified, a default coercion takes place: If the array of output argument values contains just a single value, this value is passed as a result value. If the array of output argument values is empty, undefined is passed as result value. Otherwise, the array of output argument values is passed unchanged.

If the coercion function throws an error, a Return event with a "Bad OPC UA method call" error (error code 1) is published.

Type declaration

    • (resultValues: any[]): any
    • Parameters

      • resultValues: any[]

      Returns any

inputArguments

inputArguments: OpcuaInputArgumentMapping[]

An array of mappings for OPC UA method input arguments associated with specific Call event parameters.

The order of mappings must mirror the order of OPC UA input arguments. Superfluous Call event parameters are ignored. If input argument mappings for unknown Call event parameters are specified, the associated OPC UA method is not invoked and a Return event with an InvalidParameters error is published.

operation

operation: string

The name of the Call event operation to be mapped to an OPC UA method call.

Optional operationContext

operationContext: CoatyObject

The operation context to be matched against the context filter of the Call event (optional).

Generated using TypeDoc