clear_surface_modelT_clear_surface_modelClearSurfaceModelClearSurfaceModel (Operator)

Name

clear_surface_modelT_clear_surface_modelClearSurfaceModelClearSurfaceModel — Free the memory of a surface model.

Signature

clear_surface_model( : : SurfaceModelID : )

Herror T_clear_surface_model(const Htuple SurfaceModelID)

void ClearSurfaceModel(const HTuple& SurfaceModelID)

static void HSurfaceModel::ClearSurfaceModel(const HSurfaceModelArray& SurfaceModelID)

void HSurfaceModel::ClearSurfaceModel() const

static void HOperatorSet.ClearSurfaceModel(HTuple surfaceModelID)

static void HSurfaceModel.ClearSurfaceModel(HSurfaceModel[] surfaceModelID)

void HSurfaceModel.ClearSurfaceModel()

Description

The operator clear_surface_modelclear_surface_modelClearSurfaceModelClearSurfaceModelClearSurfaceModel frees the memory of a surface model that was created by read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelReadSurfaceModel or create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelCreateSurfaceModel. After calling clear_surface_modelclear_surface_modelClearSurfaceModelClearSurfaceModelClearSurfaceModel, the model can no longer be used. The handle SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID becomes invalid.

Execution Information

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID (input_control, state is modified)  surface_model(-array) HSurfaceModel, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the surface model.

Result

If the handle of the model is valid, the operator clear_surface_modelclear_surface_modelClearSurfaceModelClearSurfaceModelClearSurfaceModel returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

Possible Predecessors

read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelReadSurfaceModel, create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelCreateSurfaceModel

See also

read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelReadSurfaceModel, create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelCreateSurfaceModel

Module

3D Metrology