Operator Reference

write_component_modelT_write_component_modelWriteComponentModelWriteComponentModelwrite_component_model (Operator)

write_component_modelT_write_component_modelWriteComponentModelWriteComponentModelwrite_component_model — Write a component model to a file.

Warning

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

Signature

write_component_model( : : ComponentModelID, FileName : )

Herror T_write_component_model(const Htuple ComponentModelID, const Htuple FileName)

void WriteComponentModel(const HTuple& ComponentModelID, const HTuple& FileName)

void HComponentModel::WriteComponentModel(const HString& FileName) const

void HComponentModel::WriteComponentModel(const char* FileName) const

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

static void HOperatorSet.WriteComponentModel(HTuple componentModelID, HTuple fileName)

void HComponentModel.WriteComponentModel(string fileName)

def write_component_model(component_model_id: HHandle, file_name: str) -> None

Description

The operator write_component_modelwrite_component_modelWriteComponentModelWriteComponentModelwrite_component_model writes the component model ComponentModelIDComponentModelIDComponentModelIDcomponentModelIDcomponent_model_id to the file FileNameFileNameFileNamefileNamefile_name. The model can be read again with read_component_modelread_component_modelReadComponentModelReadComponentModelread_component_model. 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.

Parameters

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

Handle of the component model.

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

File name.

File extension: .cbm

Result

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

Module

Matching