read_messageReadMessageReadMessageread_messageT_read_message

HALCON ScriptCpp++.NETPythonC

Short description

read_messageReadMessageReadMessageread_messageT_read_message — Read a message from a file.

Signature

read_message( filename.read FileName, attribute.name GenParamName, attribute.name GenParamValue, out message MessageHandle )void ReadMessage( const HTuple& FileName, const HTuple& GenParamName, const HTuple& GenParamValue, HTuple* MessageHandle )static void HOperatorSet.ReadMessage( HTuple fileName, HTuple genParamName, HTuple genParamValue, out HTuple messageHandle )def read_message( file_name: str, gen_param_name: MaybeSequence[str], gen_param_value: MaybeSequence[Union[int, float, str]] ) -> HHandle

Herror T_read_message( const Htuple FileName, const Htuple GenParamName, const Htuple GenParamValue, Htuple* MessageHandle )

void HMessage::HMessage( const HString& FileName, const HTuple& GenParamName, const HTuple& GenParamValue )

void HMessage::HMessage( const HString& FileName, const HString& GenParamName, const HString& GenParamValue )

void HMessage::HMessage( const char* FileName, const char* GenParamName, const char* GenParamValue )

void HMessage::HMessage( const wchar_t* FileName, const wchar_t* GenParamName, const wchar_t* GenParamValue ) (Windows only)

public HMessage( string fileName, HTuple genParamName, HTuple genParamValue )

public HMessage( string fileName, string genParamName, string genParamValue )

void HMessage::ReadMessage( const HString& FileName, const HTuple& GenParamName, const HTuple& GenParamValue )

void HMessage::ReadMessage( const HString& FileName, const HString& GenParamName, const HString& GenParamValue )

void HMessage::ReadMessage( const char* FileName, const char* GenParamName, const char* GenParamValue )

void HMessage::ReadMessage( const wchar_t* FileName, const wchar_t* GenParamName, const wchar_t* GenParamValue ) (Windows only)

void HMessage.ReadMessage( string fileName, HTuple genParamName, HTuple genParamValue )

void HMessage.ReadMessage( string fileName, string genParamName, string genParamValue )

Description

read_messageReadMessage reads a message that has been stored with write_messageWriteMessage. The default HALCON file extension for a message is 'hmsg'.

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.

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

FileNamefileNamefile_name (input_control) filename.read → (string)HTuple (HString)HTuple (string)strHtuple (char*)

File name.

File extension: .hmsg

GenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → (string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)

Name of the generic parameter.

Default: [][]
List of values: 'name'"name"

GenParamValuegenParamValuegen_param_value (input_control) attribute.name(-array) → (string / integer / real)HTuple (HString / Hlong / double)HTuple (string / int / long / double)MaybeSequence[Union[int, float, str]]Htuple (char* / Hlong / double)

Value of the generic parameter.

Default: [][]

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

Message handle.

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

Result

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

Combinations with other operators

Combinations

Possible predecessors

write_messageWriteMessage

See also

write_messageWriteMessage, serialize_handleSerializeHandle, deserialize_handleDeserializeHandle

Module

Foundation