Operator Reference

HALCON Operator Reference / Tuple / Type

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

tuple_is_valid_handleT_tuple_is_valid_handleTupleIsValidHandleTupleIsValidHandletuple_is_valid_handle (Operator)

tuple_is_valid_handleT_tuple_is_valid_handleTupleIsValidHandleTupleIsValidHandletuple_is_valid_handle — Check if a handle is valid.

Signature

tuple_is_valid_handle( : : Handle : IsValid)

Herror T_tuple_is_valid_handle(const Htuple Handle, Htuple* IsValid)

void TupleIsValidHandle(const HTuple& Handle, HTuple* IsValid)

HTuple HTuple::TupleIsValidHandle() const

HTuple HHandle::TupleIsValidHandle() const

static void HOperatorSet.TupleIsValidHandle(HTuple handle, out HTuple isValid)

HTuple HTuple.TupleIsValidHandle()

HTuple HHandle.TupleIsValidHandle()

def tuple_is_valid_handle(handle: MaybeSequence[HHandle]) -> Sequence[int]

def tuple_is_valid_handle_s(handle: MaybeSequence[HHandle]) -> int

Description

tuple_is_valid_handletuple_is_valid_handleTupleIsValidHandleTupleIsValidHandletuple_is_valid_handle returns 1 in IsValidIsValidIsValidisValidis_valid if HandleHandleHandlehandlehandle is a valid handle that has not been cleared, and 0 otherwise.

If multiple handles are passed in HandleHandleHandlehandlehandle, a validity value will be returned for each of them in IsValidIsValidIsValidisValidis_valid.

Exception: Empty input tuple

If the input tuple is empty, the operator returns an empty tuple.

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

HandleHandleHandlehandlehandle (input_control)  tuple(-array) → HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (HHandle) (HHandle) (handle)

The handle to check for validity.

IsValidIsValidIsValidisValidis_valid (output_control)  integer(-array) → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

The validity of the handle, 1 or 0.

Result

If the parameters are valid, the operator tuple_is_valid_handletuple_is_valid_handleTupleIsValidHandleTupleIsValidHandletuple_is_valid_handle returns the value 2 ( H_MSG_TRUE) . Otherwise, an exception is raised.

Module

Foundation

---

ClassesClasses | | Operators