read_component_modelT_read_component_modelReadComponentModelReadComponentModelread_component_model (Operator)
Name
read_component_modelT_read_component_modelReadComponentModelReadComponentModelread_component_model — Read a component model from a file.
Signature
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.
Possible Successors
find_component_modelfind_component_modelFindComponentModelFindComponentModelfind_component_model
Module
Matching