clear_scattered_data_interpolatorT_clear_scattered_data_interpolatorClearScatteredDataInterpolatorClearScatteredDataInterpolator (Operator)

Name

clear_scattered_data_interpolatorT_clear_scattered_data_interpolatorClearScatteredDataInterpolatorClearScatteredDataInterpolator — Clear a scattered data interpolator.

Signature

clear_scattered_data_interpolator( : : ScatteredDataInterpolatorHandle : )

Description

clear_scattered_data_interpolatorclear_scattered_data_interpolatorClearScatteredDataInterpolatorClearScatteredDataInterpolatorClearScatteredDataInterpolator clears the scattered data interpolator given by ScatteredDataInterpolatorHandleScatteredDataInterpolatorHandleScatteredDataInterpolatorHandleScatteredDataInterpolatorHandlescatteredDataInterpolatorHandle and frees all memory required for the interpolator. After calling clear_scattered_data_interpolatorclear_scattered_data_interpolatorClearScatteredDataInterpolatorClearScatteredDataInterpolatorClearScatteredDataInterpolator, the scattered data interpolator can no longer be used. The handle ScatteredDataInterpolatorHandleScatteredDataInterpolatorHandleScatteredDataInterpolatorHandleScatteredDataInterpolatorHandlescatteredDataInterpolatorHandle 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:

ScatteredDataInterpolatorHandleScatteredDataInterpolatorHandleScatteredDataInterpolatorHandleScatteredDataInterpolatorHandlescatteredDataInterpolatorHandle

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

Parameters

ScatteredDataInterpolatorHandleScatteredDataInterpolatorHandleScatteredDataInterpolatorHandleScatteredDataInterpolatorHandlescatteredDataInterpolatorHandle (input_control, state is modified) scattered_data_interpolator(-array) → (handle)

Handle of the scattered data interpolator

Result

If the parameters are valid, the operator clear_scattered_data_interpolatorclear_scattered_data_interpolatorClearScatteredDataInterpolatorClearScatteredDataInterpolatorClearScatteredDataInterpolator returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Predecessors

create_scattered_data_interpolatorcreate_scattered_data_interpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolator, interpolate_scattered_datainterpolate_scattered_dataInterpolateScatteredDataInterpolateScatteredDataInterpolateScatteredData

Module

Foundation

Operators