clear_ncc_modelT_clear_ncc_modelClearNccModelClearNccModelclear_ncc_model (Operator)

Name

clear_ncc_modelT_clear_ncc_modelClearNccModelClearNccModelclear_ncc_model — Free the memory of an NCC model.

Signature

clear_ncc_model( : : ModelID : )

Herror T_clear_ncc_model(const Htuple ModelID)

void ClearNccModel(const HTuple& ModelID)

void HNCCModel::ClearNccModel() const

static void HOperatorSet.ClearNccModel(HTuple modelID)

void HNCCModel.ClearNccModel()

def clear_ncc_model(model_id: HHandle) -> None

Description

The operator clear_ncc_modelclear_ncc_modelClearNccModelClearNccModelClearNccModelclear_ncc_model frees the memory of an NCC model that was created by create_ncc_modelcreate_ncc_modelCreateNccModelCreateNccModelCreateNccModelcreate_ncc_model. After calling clear_ncc_modelclear_ncc_modelClearNccModelClearNccModelClearNccModelclear_ncc_model, the model can no longer be used. The handle ModelIDModelIDModelIDModelIDmodelIDmodel_id becomes invalid.

Execution Information

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

ModelIDModelIDModelIDModelIDmodelIDmodel_id (input_control, state is modified)  ncc_model HNCCModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the model.

Result

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

Possible Predecessors

create_ncc_modelcreate_ncc_modelCreateNccModelCreateNccModelCreateNccModelcreate_ncc_model, read_ncc_modelread_ncc_modelReadNccModelReadNccModelReadNccModelread_ncc_model, write_ncc_modelwrite_ncc_modelWriteNccModelWriteNccModelWriteNccModelwrite_ncc_model, find_ncc_modelfind_ncc_modelFindNccModelFindNccModelFindNccModelfind_ncc_model, find_ncc_modelsfind_ncc_modelsFindNccModelsFindNccModelsFindNccModelsfind_ncc_models

Module

Matching