Operator Reference

HALCON Operator Reference / Tuple / Features

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

ClassesClasses | | Operators

get_handle_tupleT_get_handle_tupleGetHandleTupleGetHandleTupleget_handle_tuple (Operator)

get_handle_tupleT_get_handle_tupleGetHandleTupleGetHandleTupleget_handle_tuple — Retrieve a tuple associated with a key from a handle.

Signature

get_handle_tuple( : : Handle, Key : Tuple)

Herror T_get_handle_tuple(const Htuple Handle, const Htuple Key, Htuple* Tuple)

void GetHandleTuple(const HTuple& Handle, const HTuple& Key, HTuple* Tuple)

static void HOperatorSet.GetHandleTuple(HTuple handle, HTuple key, out HTuple tuple)

def get_handle_tuple(handle: HHandle, key: Union[str, int]) -> Sequence[Union[int, float, str]]

def get_handle_tuple_s(handle: HHandle, key: Union[str, int]) -> Union[int, float, str]

Description

get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleget_handle_tuple retrieves a tuple associated with the KeyKeyKeykeykey from HandleHandleHandlehandlehandle and returns it in TupleTupleTupletupletuple. The list of keys supported by a handle can be queried with get_handle_paramget_handle_paramGetHandleParamGetHandleParamget_handle_param.

Note that this operator is provided only for implementing generic debug and inspection mechanisms. The keys returned for certain handle types can change without notice. Additionally, some handle types might not be supported by this operator. Also, this operator is not optimized for performance. To obtain more reliable information about a handle in a program, it is strongly recommended to use the operators specialized for the particular handle type, such as get_object_model_3d_paramsget_object_model_3d_paramsGetObjectModel3dParamsGetObjectModel3dParamsget_object_model_3d_params, get_generic_shape_model_paramget_generic_shape_model_paramGetGenericShapeModelParamGetGenericShapeModelParamget_generic_shape_model_param etc.

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)  handle → HHandle, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of which to get the key.

KeyKeyKeykeykey (input_control)  string → HTupleUnion[str, int]HTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)

Key to get.

Number of elements: Key == 1

Restriction: length(Key) > 0

TupleTupleTupletupletuple (output_control)  tuple(-array) → HTupleSequence[Union[int, float, str]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

Control value of the key.

Result

If the parameters are valid, the operator get_handle_tupleget_handle_tupleGetHandleTupleGetHandleTupleget_handle_tuple returns the value 2 ( H_MSG_TRUE) . If the handle is invalid or does not support the given key, or if the key references an iconic object instead of a tuple, an exception is raised.

Possible Predecessors

get_handle_paramget_handle_paramGetHandleParamGetHandleParamget_handle_param

Alternatives

get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectget_handle_object

See also

get_handle_paramget_handle_paramGetHandleParamGetHandleParamget_handle_param, get_handle_objectget_handle_objectGetHandleObjectGetHandleObjectget_handle_object

Module

Foundation

---

ClassesClasses | | Operators