Operator Reference

HALCON Operator Reference / Tuple / Creation

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

ClassesClasses | | Operators

clear_handleT_clear_handleClearHandleClearHandleclear_handle (Operator)

clear_handleT_clear_handleClearHandleClearHandleclear_handle — Clear the content of a handle.

Signature

clear_handle( : : Handle : )

Herror T_clear_handle(const Htuple Handle)

void ClearHandle(const HTuple& Handle)

void HTuple::ClearHandle() const

void HHandle::ClearHandle() const

static void HOperatorSet.ClearHandle(HTuple handle)

void HTuple.ClearHandle()

void HHandle.ClearHandle()

def clear_handle(handle: MaybeSequence[HHandle]) -> None

Description

clear_handleclear_handleClearHandleClearHandleclear_handle clears the content of the handle contained in HandleHandleHandlehandlehandle. The handle is left in a cleared state afterwards. Attempts to use it in any other operator will raise an error.

Usually, handles are automatically cleared once all references in all tuples are overwritten. clear_handleclear_handleClearHandleClearHandleclear_handle can be used to clear a handle at a specific time, even if there are still references to it.

This operator can be used to clear handles of any type instead of the more specialized operators, such as clear_matrixclear_matrixClearMatrixClearMatrixclear_matrix or clear_shape_modelclear_shape_modelClearShapeModelClearShapeModelclear_shape_model.

Execution Information

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

This operator modifies the state of the following input parameter:

• HandleHandleHandlehandlehandle

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

HandleHandleHandlehandlehandle (input_control, state is modified)  tuple(-array) → HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (HHandle) (HHandle) (handle)

Handle to clear.

Result

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

See also

tuple_is_valid_handletuple_is_valid_handleTupleIsValidHandleTupleIsValidHandletuple_is_valid_handle

Module

Foundation

---

ClassesClasses | | Operators