Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OpcuaInputArgumentMapping

Defines an OPC UA method input argument to be mapped to a parameter of the associated Call event operation.

Hierarchy

  • OpcuaInputArgumentMapping

Index

Properties

Properties

Optional coerceParameter

coerceParameter: (value: any) => any

A coercion function that coerces the value of the associated Call event parameter (optional).

If not specified, no coercion takes place and the original value is used.

If the coercion function throws an error, the OPC UA method is not invoked and a Return event with an InvalidParameters error is published.

remarks

Coercion always takes place after parameter validation (see property validateParameter).

Type declaration

    • (value: any): any

    • Parameters

      • value: any

      Returns any

dataType

dataType: string | DataType

The OPC UA data type of this input argument.

parameter

parameter: string | number

The name or index of the Call event parameter to be mapped to this OPC UA method input argument. If the given parameter has not been specified in the Call event, the associated OPC UA method is not invoked and a Return event with an InvalidParameters error is published.

Optional validateParameter

validateParameter: (value: any) => boolean

A function that validates the value of the associated Call event parameter (optional).

The function should return false, if validation fails; otherwise true. If validation fails or if the function throws an error, the associated OPC UA method is not invoked and a Return event with an InvalidParameters error is published.

If this property is not specified, the parameter is not validated and the associated OPC UA method is called with the given (maybe coerced) parameter value as input argument.

Type declaration

    • (value: any): boolean

    • Parameters

      • value: any

      Returns boolean

Generated using TypeDoc