Operator Reference

get_spyget_spyGetSpyGetSpyget_spy (Operator)

get_spyget_spyGetSpyGetSpyget_spy — Current configuration of the HALCON debugging-tool.

Signature

get_spy( : : Class : Value)

Herror get_spy(const char* Class, char* Value)

Herror T_get_spy(const Htuple Class, Htuple* Value)

void GetSpy(const HTuple& Class, HTuple* Value)

static HTuple HSystem::GetSpy(const HString& Class)

static HTuple HSystem::GetSpy(const char* Class)

static HTuple HSystem::GetSpy(const wchar_t* Class)   ( Windows only)

static void HOperatorSet.GetSpy(HTuple classVal, out HTuple value)

static HTuple HSystem.GetSpy(string classVal)

def get_spy(class_val: str) -> Union[str, int, float]

Description

The operator get_spyget_spyGetSpyGetSpyget_spy returns the current configuration of spy, the HALCON debugging tool. The available control modes (possible choices for ClassClassClassclassValclass) as well as the corresponding tuning possibilities (possible values for ValueValueValuevaluevalue) can be called up by using the operator query_spyquery_spyQuerySpyQuerySpyquery_spy. You will find a more detailed description under set_spyset_spySetSpySetSpyset_spy.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

ClassClassClassclassValclass (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Control mode

Default: 'mode' "mode" "mode" "mode" "mode"

List of values: 'db'"db""db""db""db", 'error'"error""error""error""error", 'input_control'"input_control""input_control""input_control""input_control", 'internal'"internal""internal""internal""internal", 'log_file'"log_file""log_file""log_file""log_file", 'mode'"mode""mode""mode""mode", 'operator'"operator""operator""operator""operator", 'output_control'"output_control""output_control""output_control""output_control", 'parameter_values'"parameter_values""parameter_values""parameter_values""parameter_values", 'time'"time""time""time""time"

ValueValueValuevaluevalue (output_control)  string HTupleUnion[str, int, float]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

State of the control mode.

Result

The operator get_spyget_spyGetSpyGetSpyget_spy returns the value 2 ( H_MSG_TRUE) if the parameter ClassClassClassclassValclass is correct. Otherwise an exception is raised.

Possible Predecessors

reset_obj_dbreset_obj_dbResetObjDbResetObjDbreset_obj_db

See also

set_spyset_spySetSpySetSpyset_spy, query_spyquery_spyQuerySpyQuerySpyquery_spy

Module

Foundation