set_message_obj — Add a key/object pair to the message.
set_message_obj stores an object associated with a key in the message, which behaves as a dictionary-like data container. The message is denoted by the MessageHandle parameter.
ObjectData is copied by the operation (copying the object data in HALCON's object database, see copy_obj), and can thus be immediately reused. Both an empty object or an object tuple are considered as a valid value that can be associated with the key. If any data (tuple or object) was already associated with given key (Key), the old data is destroyed by set_message_obj and replaced by ObjectData.
The Key has to be a non-empty string consisting solely of lowercase or uppercase ASCII letters, digits and underscores, while only a letter can be at the first position of the key. The key string is treated case sensitive.
The object data for the given key can be retrieved again from the message using get_message_obj.
This operator modifies the state of the following input parameter:
Object to be associated with the key.
Number of elements: MessageHandle == 1
Restriction: MessageHandle != 0
Number of elements: Key == 1
Restriction: length(Key) > 0
create_message (Message) read_image( Image, 'filename') set_message_obj (Image, Message, 'my_image')
If the operation succeeds, set_message_tuple returns 2 (H_MSG_TRUE). Otherwise an exception is raised. Possible error conditions include invalid parameters (handle or key) or resource allocation error.
create_message, clear_message, set_message_tuple, get_message_tuple, get_message_obj, set_message_param, get_message_param, enqueue_message, dequeue_message