Skip to content

clear_ncc_modelClearNccModelClearNccModelclear_ncc_modelT_clear_ncc_model🔗

Short description🔗

clear_ncc_modelClearNccModelClearNccModelclear_ncc_modelT_clear_ncc_model — Free the memory of an NCC model.

Signature🔗

clear_ncc_model( ncc_model ModelID )void ClearNccModel( const HTuple& ModelID )static void HOperatorSet.ClearNccModel( HTuple modelID )def clear_ncc_model( model_id: HHandle ) -> None

Herror T_clear_ncc_model( const Htuple ModelID )

void HNCCModel::ClearNccModel( ) const

void HNCCModel.ClearNccModel( )

Description🔗

The operator clear_ncc_modelClearNccModel frees the memory of an NCC model that was created by create_ncc_modelCreateNccModel. After calling clear_ncc_modelClearNccModel, 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) ncc_model → (handle)HTuple (HHandle)HNCCModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the model.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_ncc_modelCreateNccModel, read_ncc_modelReadNccModel, write_ncc_modelWriteNccModel, find_ncc_modelFindNccModel, find_ncc_modelsFindNccModels

Module🔗

Matching