read_component_modelT_read_component_modelReadComponentModelReadComponentModel (Operator)

Name

read_component_modelT_read_component_modelReadComponentModelReadComponentModel — Read a component model from a file.

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)

Description

The operator read_component_modelread_component_modelReadComponentModelReadComponentModelReadComponentModel reads a component model, which has been written with write_component_modelwrite_component_modelWriteComponentModelWriteComponentModelWriteComponentModel, from the file FileNameFileNameFileNameFileNamefileName and returns it in ComponentModelIDComponentModelIDComponentModelIDComponentModelIDcomponentModelID. The default HALCON file extension for the component model is 'cbm'.

Execution Information

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

FileNameFileNameFileNameFileNamefileName (input_control)  filename.read HTupleHTupleHtuple (string) (string) (HString) (char*)

File name.

File extension: .cbm

ComponentModelIDComponentModelIDComponentModelIDComponentModelIDcomponentModelID (output_control)  component_model HComponentModel, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the component model.

Result

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

Possible Successors

find_component_modelfind_component_modelFindComponentModelFindComponentModelFindComponentModel

Module

Matching