get_handle_paramGetHandleParamGetHandleParamget_handle_paramT_get_handle_param

HALCON ScriptCpp++.NETPythonC

Short description

get_handle_paramGetHandleParamGetHandleParamget_handle_paramT_get_handle_param — Return information about a handle.

Signature

get_handle_param( handle Handle, string GenParamName, string Key, out tuple GenParamValue )void GetHandleParam( const HTuple& Handle, const HTuple& GenParamName, const HTuple& Key, HTuple* GenParamValue )static void HOperatorSet.GetHandleParam( HTuple handle, HTuple genParamName, HTuple key, out HTuple genParamValue )def get_handle_param( handle: HHandle, gen_param_name: str, key: MaybeSequence[str] ) -> Sequence[Union[int, float, str]]

def get_handle_param_s( handle: HHandle, gen_param_name: str, key: MaybeSequence[str] ) -> Union[int, float, str]Herror T_get_handle_param( const Htuple Handle, const Htuple GenParamName, const Htuple Key, Htuple* GenParamValue )

Description

get_handle_paramGetHandleParam returns details about Handlehandlehandle in GenParamValuegenParamValuegen_param_value. It provides a generic mechanism for inspecting and debugging handles of any type by returning keys of that handle that can later be queried using get_handle_tupleGetHandleTuple and get_handle_objectGetHandleObject.

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_paramsGetObjectModel3dParams, get_generic_shape_model_paramGetGenericShapeModelParam etc.

Depending on the value of GenParamNamegenParamNamegen_param_name, the following values can be queried:

• 'keys'"keys": Returns a list of keys that this handle supports in GenParamValuegenParamValuegen_param_value. Each key contains either a tuple or an iconic object. For this query, the parameter Keykeykey must be empty. Note that due to the generic nature of this operator, some of the returned keys might not be valid for the particular handle. In this case, get_handle_tupleGetHandleTuple or get_handle_objectGetHandleObject will return an error for those keys.

• 'key_data_type'"key_data_type": Returns the data type of Keykeykey. The type is returned in GenParamValuegenParamValuegen_param_value and is either 'tuple'"tuple" or 'object'"object". Depending on the type, the key’s corresponding value can be queried with get_handle_tupleGetHandleTuple or get_handle_objectGetHandleObject, respectively.

Execution information

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

Handlehandlehandle (input_control) handle → (handle)HTuple (HHandle)HHandle, HTuple (IntPtr)HHandleHtuple (handle)

Handle of which to get the parameter.

GenParamNamegenParamNamegen_param_name (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Parameter to get.

Default: 'keys'"keys"
List of values: 'key_data_type', 'keys'"key_data_type", "keys"

Keykeykey (input_control) string(-array) → (string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)

Optional key.

Default: [][]

GenParamValuegenParamValuegen_param_value (output_control) tuple(-array) → (string / integer / real)HTuple (HString / Hlong / double)HTuple (string / int / long / double)Sequence[Union[int, float, str]]Htuple (char* / Hlong / double)

Returned value.

Result

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

Combinations with other operators

Combinations

Possible successors

clear_handleClearHandle, get_handle_tupleGetHandleTuple, get_handle_objectGetHandleObject

See also

get_handle_tupleGetHandleTuple, get_handle_objectGetHandleObject

Module

Foundation