Operator Reference

HALCON Operator Reference / System / Parameters
ClassesClasses | | Operators

set_operator_timeoutset_operator_timeoutSetOperatorTimeoutSetOperatorTimeoutset_operator_timeout (Operator)

set_operator_timeoutset_operator_timeoutSetOperatorTimeoutSetOperatorTimeoutset_operator_timeout — Set a timeout for an operator.

Signature

set_operator_timeout( : : OperatorName, Timeout, Mode : )

Herror set_operator_timeout(const char* OperatorName, double Timeout, const char* Mode)

Herror T_set_operator_timeout(const Htuple OperatorName, const Htuple Timeout, const Htuple Mode)

void SetOperatorTimeout(const HTuple& OperatorName, const HTuple& Timeout, const HTuple& Mode)

static void HOperatorSet.SetOperatorTimeout(HTuple operatorName, HTuple timeout, HTuple mode)

def set_operator_timeout(operator_name: MaybeSequence[str], timeout: MaybeSequence[Union[int, float, str]], mode: str) -> None

Description

set_operator_timeoutset_operator_timeoutSetOperatorTimeoutSetOperatorTimeoutset_operator_timeout sets a timeout for the operator OperatorNameOperatorNameOperatorNameoperatorNameoperator_name. TimeoutTimeoutTimeouttimeouttimeout is given in seconds. Setting TimeoutTimeoutTimeouttimeouttimeout to 0 or 'off'"off""off""off""off" clears the timeout. The timeout is set for the current thread only and is not inherited by child threads.

Multiple operator names can be passed to OperatorNameOperatorNameOperatorNameoperatorNameoperator_name. In this case, one can either pass a single timeout in TimeoutTimeoutTimeouttimeouttimeout, which is then set for all operators, or one timeout per operator.

Two timeout modes are supported and selected with ModeModeModemodemode:

'cancel'

Cancels the execution of the operator after the timeout expires, raises the exception H_ERR_TIMEOUT (9400). All results computed by the operator are discarded.

'break'

Break the execution of the operator after the timeout expires. The operator returns normally. If possible, results computed by the operator up to the point of the timeout are returned.

Attention

Note that not all operators support timeouts. If a given operator supports timeouts and which modes are supported is described in the execution information section of the reference documentation of the corresponding operator.

Also note that there is no hard guarantee about the granularity of the timeout. The granularity can depend on the operator, its input data and the speed of the device. It is typically finer than 10 ms.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: local (may only be called from the same thread in which the window, model, or tool instance was created).
  • Processed without parallelization.

Parameters

OperatorNameOperatorNameOperatorNameoperatorNameoperator_name (input_control)  string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Operator for which the timeout shall be set.

TimeoutTimeoutTimeouttimeouttimeout (input_control)  number(-array) → HTupleMaybeSequence[Union[int, float, str]]HTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)

Timeout in seconds.

Default: 1

Suggested values: 1, 0.1, 0.5, 'off'"off""off""off""off", 0

ModeModeModemodemode (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Timeout mode to be set.

Default: 'cancel' "cancel" "cancel" "cancel" "cancel"

Suggested values: 'cancel'"cancel""cancel""cancel""cancel", 'break'"break""break""break""break"

Result

The operator set_operator_timeoutset_operator_timeoutSetOperatorTimeoutSetOperatorTimeoutset_operator_timeout returns the value 2 ( H_MSG_TRUE) if the parameters are correct. Otherwise an exception will be raised.

Alternatives

interrupt_operatorinterrupt_operatorInterruptOperatorInterruptOperatorinterrupt_operator

See also

interrupt_operatorinterrupt_operatorInterruptOperatorInterruptOperatorinterrupt_operator, get_current_hthread_idget_current_hthread_idGetCurrentHthreadIdGetCurrentHthreadIdget_current_hthread_id

Module

Foundation

ClassesClasses | | Operators