Operator Reference

HALCON Operator Reference / Legacy / Matching
ClassesClasses | | Operators

serialize_templateT_serialize_templateSerializeTemplateSerializeTemplateserialize_template (Operator)

serialize_templateT_serialize_templateSerializeTemplateSerializeTemplateserialize_template — Serialize a template.

Warning

serialize_templateserialize_templateSerializeTemplateSerializeTemplateserialize_template is obsolete and is only provided for reasons of backward compatibility. The operator will be removed with HALCON 25.11. New applications should use the shape-based or NCC-based operators instead.

Signature

serialize_template( : : TemplateID : SerializedItemHandle)

Herror T_serialize_template(const Htuple TemplateID, Htuple* SerializedItemHandle)

void SerializeTemplate(const HTuple& TemplateID, HTuple* SerializedItemHandle)

HSerializedItem HTemplate::SerializeTemplate() const

static void HOperatorSet.SerializeTemplate(HTuple templateID, out HTuple serializedItemHandle)

HSerializedItem HTemplate.SerializeTemplate()

def serialize_template(template_id: HHandle) -> HHandle

Description

serialize_templateserialize_templateSerializeTemplateSerializeTemplateserialize_template serializes the data of a template (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item for an introduction of the basic principle of serialization). The same data that is written in a file by write_templatewrite_templateWriteTemplateWriteTemplatewrite_template is converted to a serialized item. The template is defined by the handle TemplateIDTemplateIDTemplateIDtemplateIDtemplate_id. The serialized template is returned by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by deserialize_templatedeserialize_templateDeserializeTemplateDeserializeTemplatedeserialize_template.

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

TemplateIDTemplateIDTemplateIDtemplateIDtemplate_id (input_control)  template → HTemplate, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the template.

SerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle (output_control)  serialized_item → HSerializedItem, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the serialized item.

Result

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

Possible Predecessors

create_templatecreate_templateCreateTemplateCreateTemplatecreate_template, create_template_rotcreate_template_rotCreateTemplateRotCreateTemplateRotcreate_template_rot

Possible Successors

fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item, send_serialized_itemsend_serialized_itemSendSerializedItemSendSerializedItemsend_serialized_item, deserialize_templatedeserialize_templateDeserializeTemplateDeserializeTemplatedeserialize_template

Module

Matching

ClassesClasses | | Operators