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 : )

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

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

This operator modifies the state of the following input parameter:

SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID (input_control, state is modified) surface_model(-array) → (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

Module

3D Metrology

Operators