Skip to content

tuple_constantTupleConstantTupleConstanttuple_constanttuple_constant🔗

Short description🔗

tuple_constantTupleConstantTupleConstanttuple_constanttuple_constant — Generate a tuple with the value of a HDevelop language constant.

Signature🔗

tuple_constant( tuple Name, out tuple Value )void TupleConstant( const HTuple& Name, HTuple* Value )static void HOperatorSet.TupleConstant( HTuple name, out HTuple value )def tuple_constant( name: str ) -> Union[float, int, HHandle]

Herror tuple_constant( const char* Name, Hlong* Value )

Herror T_tuple_constant( const Htuple Name, Htuple* Value )

static HTuple HTuple::TupleConstant( const HTuple& Name )

static HTuple HTuple.TupleConstant( HTuple name )

Description🔗

tuple_constantTupleConstant generates a new tuple with the value of a HDevelop language constant.

HDevelop In-line Operation🔗

HDevelop provides an in-line operation for tuple_constantTupleConstant, which can be used in an expression in the following syntax:

Value := constant(Name)

Attention🔗

H_INT64_MIN and H_INT64_MAX will both produce an error if 32-bit HALCON is being used, as they cannot be represented in the then 32-bit integer used in tuples.

H_INT_MIN and H_INT_MAX will produce different values depending on whether HALCON 32- or 64-bit is being used.

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.

Parameters🔗

Namenamename (input_control) tuple → (string)HTuple (HString)HTuple (string)strHtuple (char*)

The name of the HDevelop language constant as string.

Default: 'H_INT32_MIN'"H_INT32_MIN"
List of values: 'HNULL', 'H_FLOAT32_EPSILON', 'H_FLOAT32_MAX', 'H_FLOAT32_MIN', 'H_FLOAT32_MIN_POSITIVE', 'H_FLOAT64_EPSILON', 'H_FLOAT64_MAX', 'H_FLOAT64_MIN', 'H_FLOAT64_MIN_POSITIVE', 'H_FLOAT_INFINITY', 'H_FLOAT_NAN', 'H_FLOAT_NEG_INFINITY', 'H_INT32_MAX', 'H_INT32_MIN', 'H_INT64_MAX', 'H_INT64_MIN', 'H_INT_MAX', 'H_INT_MIN', 'H_MSG_FAIL', 'H_MSG_FALSE', 'H_MSG_TRUE', 'H_MSG_VOID', 'H_TYPE_ANY', 'H_TYPE_HANDLE', 'H_TYPE_INT', 'H_TYPE_MIXED', 'H_TYPE_REAL', 'H_TYPE_STRING', 'false', 'true'"HNULL", "H_FLOAT32_EPSILON", "H_FLOAT32_MAX", "H_FLOAT32_MIN", "H_FLOAT32_MIN_POSITIVE", "H_FLOAT64_EPSILON", "H_FLOAT64_MAX", "H_FLOAT64_MIN", "H_FLOAT64_MIN_POSITIVE", "H_FLOAT_INFINITY", "H_FLOAT_NAN", "H_FLOAT_NEG_INFINITY", "H_INT32_MAX", "H_INT32_MIN", "H_INT64_MAX", "H_INT64_MIN", "H_INT_MAX", "H_INT_MIN", "H_MSG_FAIL", "H_MSG_FALSE", "H_MSG_TRUE", "H_MSG_VOID", "H_TYPE_ANY", "H_TYPE_HANDLE", "H_TYPE_INT", "H_TYPE_MIXED", "H_TYPE_REAL", "H_TYPE_STRING", "false", "true"

Valuevaluevalue (output_control) tuple → (integer / real / handle)HTuple (Hlong / double / HHandle)HTuple (int / long / double / HHandle)Union[float, int, HHandle]Htuple (Hlong / double / handle)

The value of the constant.

Module🔗

Foundation