Operator Reference

read_component_modelT_read_component_modelReadComponentModelReadComponentModelread_component_model (Operator)

read_component_modelT_read_component_modelReadComponentModelReadComponentModelread_component_model — Read a component model from a file.

Warning

read_component_modelread_component_modelReadComponentModelReadComponentModelread_component_model is obsolete and is only provided for reasons of backward compatibility. The operator will be removed with HALCON 26.11.

Signature

read_component_model( : : FileName : ComponentModelID)

Herror T_read_component_model(const Htuple FileName, Htuple* ComponentModelID)

void ReadComponentModel(const HTuple& FileName, HTuple* ComponentModelID)

void HComponentModel::HComponentModel(const HString& FileName)

void HComponentModel::HComponentModel(const char* FileName)

void HComponentModel::HComponentModel(const wchar_t* FileName)   ( Windows only)

void HComponentModel::ReadComponentModel(const HString& FileName)

void HComponentModel::ReadComponentModel(const char* FileName)

void HComponentModel::ReadComponentModel(const wchar_t* FileName)   ( Windows only)

static void HOperatorSet.ReadComponentModel(HTuple fileName, out HTuple componentModelID)

public HComponentModel(string fileName)

void HComponentModel.ReadComponentModel(string fileName)

def read_component_model(file_name: str) -> HHandle

Description

The operator read_component_modelread_component_modelReadComponentModelReadComponentModelread_component_model reads a component model, which has been written with write_component_modelwrite_component_modelWriteComponentModelWriteComponentModelwrite_component_model, from the file FileNameFileNameFileNamefileNamefile_name and returns it in ComponentModelIDComponentModelIDComponentModelIDcomponentModelIDcomponent_model_id. The default HALCON file extension for the component model is 'cbm'.

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

FileNameFileNameFileNamefileNamefile_name (input_control)  filename.read HTuplestrHTupleHtuple (string) (string) (HString) (char*)

File name.

File extension: .cbm

ComponentModelIDComponentModelIDComponentModelIDcomponentModelIDcomponent_model_id (output_control)  component_model HComponentModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the component model.

Result

If the file name is valid, the operator read_component_modelread_component_modelReadComponentModelReadComponentModelread_component_model returns the value 2 ( H_MSG_TRUE) . If necessary, an exception is raised.

Module

Matching