get_message_paramGetMessageParamGetMessageParamget_message_paramT_get_message_param

HALCON ScriptCpp++.NETPythonC

Short description

get_message_paramGetMessageParamGetMessageParamget_message_paramT_get_message_param — Query message parameters or information about the message.

Signature

get_message_param( message MessageHandle, string GenParamName, string Key, out tuple GenParamValue )void GetMessageParam( const HTuple& MessageHandle, const HTuple& GenParamName, const HTuple& Key, HTuple* GenParamValue )static void HOperatorSet.GetMessageParam( HTuple messageHandle, HTuple genParamName, HTuple key, out HTuple genParamValue )def get_message_param( message_handle: HHandle, gen_param_name: str, key: MaybeSequence[Union[str, int]] ) -> Sequence[Union[int, float, str]]

def get_message_param_s( message_handle: HHandle, gen_param_name: str, key: MaybeSequence[Union[str, int]] ) -> Union[int, float, str]Herror T_get_message_param( const Htuple MessageHandle, const Htuple GenParamName, const Htuple Key, Htuple* GenParamValue )

HTuple HMessage::GetMessageParam( const HString& GenParamName, const HTuple& Key ) const

HTuple HMessage::GetMessageParam( const HString& GenParamName, const HString& Key ) const

HTuple HMessage::GetMessageParam( const char* GenParamName, const char* Key ) const

HTuple HMessage::GetMessageParam( const wchar_t* GenParamName, const wchar_t* Key ) const (Windows only)

HTuple HMessage.GetMessageParam( string genParamName, HTuple key )

HTuple HMessage.GetMessageParam( string genParamName, string key )

Description

get_message_paramGetMessageParam queries current values of message parameters or other information about the message status.

With each call of get_message_paramGetMessageParam, only a single parameter value can be queried. However, there are two types of parameters/queries:

• Parameters/queries applicable to the entire message. In this case no keys must be specified, the parameter Keykeykey must be an empty tuple.

• Parameters/queries applicable to the individual keys. In this case a non-empty list of keys must be specified in the parameter Keykeykey. The keys are processed in the same order as specified in the Keykeykey parameter.

Key-independent (global) parameter names:

• 'message_keys'"message_keys": Queries all the keys stored in the message, no matter whether they are associated with tuple or object data. The list of keys is reported as a string tuple via GenParamValuegenParamValuegen_param_value. For this query the parameter Keykeykey must be an empty tuple.

Currently supported key-specific parameter names are:

• 'key_exists'"key_exists": Reports 11 if the given key is stored in the message, 00 otherwise. The results are reported via GenParamValuegenParamValuegen_param_value, one value for each key.

• 'key_data_type'"key_data_type": Reports 'tuple'"tuple" for keys associated with tuple data within the message (the data can be retrieved using get_message_tupleGetMessageTuple). Reports 'object'"object" for keys associated with object data (the data can be retrieved using get_message_objGetMessageObj). The results are reported via GenParamValuegenParamValuegen_param_value, one value for each key. This parameter is useful to decide dynamically whether to use get_message_tupleGetMessageTuple or get_message_objGetMessageObj to get the data of a specific key.

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

MessageHandlemessageHandlemessage_handle (input_control) message → (handle)HTuple (HHandle)HMessage, HTuple (IntPtr)HHandleHtuple (handle)

Message handle.

Number of elements: MessageHandle == 1
Restriction: MessageHandle != 0

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

Names of the message parameters or info queries.

Number of elements: GenParamName == GenParamValue
Default: 'message_keys'"message_keys"
List of values: 'key_data_type', 'key_exists', 'message_keys'"key_data_type", "key_exists", "message_keys"

Keykeykey (input_control) string(-array) → (string / integer)HTuple (HString / Hlong)HTuple (string / int / long)MaybeSequence[Union[str, int]]Htuple (char* / Hlong)

Message keys the parameter/query should be applied to.

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)

Values of the message parameters or info queries.

Example

(HDevelop)

get_message_param (Message, 'message_keys', [], AllKeys)
get_message_param (Message, 'key_data_type', AllKeys, KeysType)

Result

If all the operator parameters, and the specified keys are valid, get_message_paramGetMessageParam returns 2 (H_MSG_TRUE). Otherwise an exception is raised.

Combinations with other operators

Combinations

Possible predecessors

dequeue_messageDequeueMessage

See also

create_messageCreateMessage, clear_messageClearMessage, set_message_tupleSetMessageTuple, get_message_tupleGetMessageTuple, set_message_objSetMessageObj, get_message_objGetMessageObj, set_message_paramSetMessageParam, enqueue_messageEnqueueMessage, dequeue_messageDequeueMessage

Module

Foundation