ClassesClassesClassesClasses | | | | Operators

read_component_modelread_component_modelReadComponentModelread_component_modelReadComponentModelReadComponentModel (Operator)

Name

read_component_modelread_component_modelReadComponentModelread_component_modelReadComponentModelReadComponentModel — Read a component model from a file.

Signature

read_component_model( : : FileName : ComponentModelID)

Herror read_component_model(const char* FileName, Hlong* ComponentModelID)

Herror T_read_component_model(const Htuple FileName, Htuple* ComponentModelID)

Herror read_component_model(const HTuple& FileName, Hlong* ComponentModelID)

void HComponentModel::ReadComponentModel(const HTuple& FileName)

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

void HComponentModel::HComponentModel(const HString& FileName)

void HComponentModel::HComponentModel(const char* FileName)

void HComponentModel::ReadComponentModel(const HString& FileName)

void HComponentModel::ReadComponentModel(const char* FileName)

void HOperatorSetX.ReadComponentModel(
[in] VARIANT FileName, [out] VARIANT* ComponentModelID)

void HComponentModelX.ReadComponentModel([in] BSTR FileName)

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_modelReadComponentModelread_component_modelReadComponentModelReadComponentModel reads a component model, which has been written with write_component_modelwrite_component_modelWriteComponentModelwrite_component_modelWriteComponentModelWriteComponentModel, from the file FileNameFileNameFileNameFileNameFileNamefileName and returns it in ComponentModelIDComponentModelIDComponentModelIDComponentModelIDComponentModelIDcomponentModelID. The default HALCON file extension for the component model is 'cbm'.

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

FileNameFileNameFileNameFileNameFileNamefileName (input_control)  filename.read HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

File name.

File extension: .cbm

ComponentModelIDComponentModelIDComponentModelIDComponentModelIDComponentModelIDcomponentModelID (output_control)  component_model HComponentModel, HTupleHTupleHComponentModel, HTupleHComponentModelX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the component model.

Result

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

Possible Successors

find_component_modelfind_component_modelFindComponentModelfind_component_modelFindComponentModelFindComponentModel

Module

Matching


ClassesClassesClassesClasses | | | | Operators