Operator Reference

HALCON Operator Reference / Tuple / Type

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

tuple_is_handleT_tuple_is_handleTupleIsHandleTupleIsHandletuple_is_handle (Operator)

tuple_is_handleT_tuple_is_handleTupleIsHandleTupleIsHandletuple_is_handle — Test if the internal representation of a tuple is of type handle.

Signature

tuple_is_handle( : : T : IsHandle)

Herror T_tuple_is_handle(const Htuple T, Htuple* IsHandle)

void TupleIsHandle(const HTuple& T, HTuple* IsHandle)

HTuple HTuple::TupleIsHandle() const

static void HOperatorSet.TupleIsHandle(HTuple t, out HTuple isHandle)

HTuple HTuple.TupleIsHandle()

def tuple_is_handle(t: HTupleType) -> int

Description

tuple_is_handletuple_is_handleTupleIsHandleTupleIsHandletuple_is_handle tests if the internal representation of the input tuple TTTtt is of type handle. In that case the value 1 (true) is returned in IsHandleIsHandleIsHandleisHandleis_handle, otherwise the value 0 (false) is returned. If a tuple consists of handle elements only, IsHandleIsHandleIsHandleisHandleis_handle can nevertheless be 0 in case the internal representation is H_TYPE_MIXED; see tuple_typetuple_typeTupleTypeTupleTypetuple_type for details.

Exception: Empty input tuple

If the input tuple is empty, the operator returns 1.

HDevelop In-line Operation

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

IsHandle := is_handle(T)

Attention

Even if all tuple elements are of type handle, tuple_is_handletuple_is_handleTupleIsHandleTupleIsHandletuple_is_handle returns 0 (false) if the internal representation of the tuple is of type H_TYPE_MIXED. To test if the elements of the tuple are of type handle, the operator tuple_is_handle_elemtuple_is_handle_elemTupleIsHandleElemTupleIsHandleElemtuple_is_handle_elem should be used.

Execution Information

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

Parameters

TTTtt (input_control)  tuple(-array) → HTupleHTupleTypeHTupleHtuple (handle / real / integer / string) (HHandle / double / int / long / string) (HHandle / double / Hlong / HString) (handle / double / Hlong / char*)

Input tuple.

IsHandleIsHandleIsHandleisHandleis_handle (output_control)  number → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Boolean value indicating if the input tuple is of type handle.

Result

If the parameters are valid, the operator tuple_is_handletuple_is_handleTupleIsHandleTupleIsHandletuple_is_handle returns the value 2 ( H_MSG_TRUE) .

Alternatives

tuple_typetuple_typeTupleTypeTupleTypetuple_type, tuple_is_numbertuple_is_numberTupleIsNumberTupleIsNumbertuple_is_number, tuple_is_handle_elemtuple_is_handle_elemTupleIsHandleElemTupleIsHandleElemtuple_is_handle_elem, tuple_is_stringtuple_is_stringTupleIsStringTupleIsStringtuple_is_string, tuple_sem_typetuple_sem_typeTupleSemTypeTupleSemTypetuple_sem_type

See also

tuple_is_inttuple_is_intTupleIsIntTupleIsInttuple_is_int, tuple_is_realtuple_is_realTupleIsRealTupleIsRealtuple_is_real, tuple_is_stringtuple_is_stringTupleIsStringTupleIsStringtuple_is_string

Module

Foundation

---

ClassesClasses | | Operators