ClassesClasses | | Operators

set_ncc_model_paramT_set_ncc_model_paramSetNccModelParamSetNccModelParam (Operator)

Name

set_ncc_model_paramT_set_ncc_model_paramSetNccModelParamSetNccModelParam — Set selected parameters of the NCC model.

Signature

set_ncc_model_param( : : ModelID, GenParamName, GenParamValue : )

Herror T_set_ncc_model_param(const Htuple ModelID, const Htuple GenParamName, const Htuple GenParamValue)

void SetNccModelParam(const HTuple& ModelID, const HTuple& GenParamName, const HTuple& GenParamValue)

void HNCCModel::SetNccModelParam(const HTuple& GenParamName, const HTuple& GenParamValue) const

static void HImage::SetNccModelParam(const HNCCModel& ModelID, const HTuple& GenParamName, const HTuple& GenParamValue)

static void HOperatorSet.SetNccModelParam(HTuple modelID, HTuple genParamName, HTuple genParamValue)

void HNCCModel.SetNccModelParam(HTuple genParamName, HTuple genParamValue)

static void HImage.SetNccModelParam(HNCCModel modelID, HTuple genParamName, HTuple genParamValue)

Description

The operator set_ncc_model_paramset_ncc_model_paramSetNccModelParamSetNccModelParamSetNccModelParam sets the selected parameters GenParamNameGenParamNameGenParamNameGenParamNamegenParamName in the NCC model ModelIDModelIDModelIDModelIDmodelID. The following parameters can be modified:

'timeout'"timeout""timeout""timeout""timeout"

Sets the maximum runtime of the operators used to find the NCC model ModelIDModelIDModelIDModelIDmodelID (using find_ncc_modelfind_ncc_modelFindNccModelFindNccModelFindNccModel). This is especially useful in cases where a maximum cycle time has to be ensured. The '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" set via set_systemset_systemSetSystemSetSystemSetSystem. 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".

Execution Information

This operator modifies the state of the following input parameter:

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

ModelIDModelIDModelIDModelIDmodelID (input_control, state is modified)  ncc_model HNCCModel, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the model.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control)  attribute.name-array HTupleHTupleHtuple (string) (string) (HString) (char*)

Parameter names.

List of values: 'timeout'"timeout""timeout""timeout""timeout"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (input_control)  attribute.value-array HTupleHTupleHtuple (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_paramSetNccModelParamSetNccModelParamSetNccModelParam returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

Possible Predecessors

create_ncc_modelcreate_ncc_modelCreateNccModelCreateNccModelCreateNccModel

Possible Successors

find_ncc_modelfind_ncc_modelFindNccModelFindNccModelFindNccModel

Module

Matching


ClassesClasses | | Operators