Skip to content

clear_variation_modelClearVariationModelClearVariationModelclear_variation_modelT_clear_variation_model🔗

Short description🔗

clear_variation_modelClearVariationModelClearVariationModelclear_variation_modelT_clear_variation_model — Free the memory of a variation model.

Signature🔗

clear_variation_model( variation_model ModelID )void ClearVariationModel( const HTuple& ModelID )static void HOperatorSet.ClearVariationModel( HTuple modelID )def clear_variation_model( model_id: HHandle ) -> None

Herror T_clear_variation_model( const Htuple ModelID )

void HVariationModel::ClearVariationModel( ) const

void HVariationModel.ClearVariationModel( )

Description🔗

clear_variation_modelClearVariationModel frees the memory of a variation model that was created by create_variation_modelCreateVariationModel. After calling create_variation_modelCreateVariationModel, the model can no longer be used. The handle ModelIDmodelIDmodel_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🔗

ModelIDmodelIDmodel_id (input_control, state is modified) variation_model → (handle)HTuple (HHandle)HVariationModel, HTuple (IntPtr)HHandleHtuple (handle)

ID of the variation model.

Result🔗

clear_variation_modelClearVariationModel returns 2 (H_MSG_TRUE) if all parameters are correct.

Combinations with other operators🔗

Combinations

Possible predecessors

create_variation_modelCreateVariationModel

Module🔗

Matching