Skip to content

clear_surface_modelClearSurfaceModelClearSurfaceModelclear_surface_modelT_clear_surface_model🔗

Short description🔗

clear_surface_modelClearSurfaceModelClearSurfaceModelclear_surface_modelT_clear_surface_model — Free the memory of a surface model.

Signature🔗

clear_surface_model( surface_model SurfaceModelID )void ClearSurfaceModel( const HTuple& SurfaceModelID )static void HOperatorSet.ClearSurfaceModel( HTuple surfaceModelID )def clear_surface_model( surface_model_id: MaybeSequence[HHandle] ) -> None

Herror T_clear_surface_model( const Htuple SurfaceModelID )

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

void HSurfaceModel::ClearSurfaceModel( ) const

static void HSurfaceModel.ClearSurfaceModel( HSurfaceModel[] surfaceModelID )

void HSurfaceModel.ClearSurfaceModel( )

Description🔗

The operator clear_surface_modelClearSurfaceModel frees the memory of a surface model that was created by read_surface_modelReadSurfaceModel or create_surface_modelCreateSurfaceModel. After calling clear_surface_modelClearSurfaceModel, the model can no longer be used. The handle SurfaceModelIDsurfaceModelIDsurface_model_id becomes invalid.

Execution information🔗

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:

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

Parameters🔗

SurfaceModelIDsurfaceModelIDsurface_model_id (input_control, state is modified) surface_model(-array) → (handle)HTuple (HHandle)HSurfaceModel, HTuple (IntPtr)MaybeSequence[HHandle]Htuple (handle)

Handle of the surface model.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

read_surface_modelReadSurfaceModel, create_surface_modelCreateSurfaceModel

See also

read_surface_modelReadSurfaceModel, create_surface_modelCreateSurfaceModel

Module🔗

3D Metrology