set_ncc_model_paramT_set_ncc_model_paramSetNccModelParamSetNccModelParamset_ncc_model_param (Operator)
Name
set_ncc_model_paramT_set_ncc_model_paramSetNccModelParamSetNccModelParamset_ncc_model_param — Set selected parameters of the NCC model.
Signature
Description
The operator set_ncc_model_paramset_ncc_model_paramSetNccModelParamSetNccModelParamSetNccModelParamset_ncc_model_param sets the selected parameters
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name in the NCC model ModelIDModelIDModelIDModelIDmodelIDmodel_id. The following
parameters can be modified:
'timeout'"timeout""timeout""timeout""timeout""timeout"
Sets the maximum runtime of the operators used to find the NCC model
ModelIDModelIDModelIDModelIDmodelIDmodel_id (using find_ncc_modelfind_ncc_modelFindNccModelFindNccModelFindNccModelfind_ncc_model). This is especially useful
in cases where a maximum cycle time has to be ensured. The 'timeout'"timeout""timeout""timeout""timeout""timeout"
must be given in milliseconds. The temporal accuracy depends on several
factors including the size of the model, the speed of your computer, and
the 'timer_mode'"timer_mode""timer_mode""timer_mode""timer_mode""timer_mode" set via set_systemset_systemSetSystemSetSystemSetSystemset_system. Be aware that the
runtime of the search increases by up to 10 percent with activated timeout.
To disable the timeout you can either use a negative value or
'false'"false""false""false""false""false".
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
ModelIDModelIDModelIDModelIDmodelIDmodel_id (input_control, state is modified) ncc_model → HNCCModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the model.
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Parameter names.
List of values: 'timeout'"timeout""timeout""timeout""timeout""timeout"
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control) attribute.value-array → HTupleSequence[Union[float, int, str]]HTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)
Parameter values.
Result
If the parameters are valid, the operator set_ncc_model_paramset_ncc_model_paramSetNccModelParamSetNccModelParamSetNccModelParamset_ncc_model_param
returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.
Possible Predecessors
create_ncc_modelcreate_ncc_modelCreateNccModelCreateNccModelCreateNccModelcreate_ncc_model
Possible Successors
find_ncc_modelfind_ncc_modelFindNccModelFindNccModelFindNccModelfind_ncc_model
Module
Matching