Open Search
    TupleValue Class Reference

    #include <datatype.h>

    Detailed Description

    A TupleValue is returned by DataType::GetTuple() if the type represents a tuple data type. The members of the tuple value can be accessed through the functions of this class.

    Public Member Functions

    template<typename T >
    const T & Get (Int index, const TupleDataType &type) const
     
    template<typename T >
    T & Get (Int index, const TupleDataType &type)
     
    const TupleValueGetTuple (Int index, const TupleDataType &type) const
     
    TupleValueGetTuple (Int index, const TupleDataType &type)
     

    Member Function Documentation

    ◆ Get() [1/2]

    const T& Get ( Int  index,
    const TupleDataType type 
    ) const

    Returns a reference to the value of the tuple member at index.

    Template Parameters
    TType of the member.
    Parameters
    [in]indexIndex of the member.
    [in]typeTuple data type of this TupleValue.
    Returns
    Reference to the member value.

    ◆ Get() [2/2]

    T& Get ( Int  index,
    const TupleDataType type 
    )

    Returns a reference to the value of the tuple member at index.

    Template Parameters
    TType of the member.
    Parameters
    [in]indexIndex of the member.
    [in]typeTuple data type of this TupleValue.
    Returns
    Reference to the member value.

    ◆ GetTuple() [1/2]

    const TupleValue& GetTuple ( Int  index,
    const TupleDataType type 
    ) const

    Returns a reference to the tuple value of the tuple member at index. The corresponding member type has to be a tuple data type.

    Parameters
    [in]indexIndex of the member.
    [in]typeTuple data type of this TupleValue.
    Returns
    Reference to the member value.

    ◆ GetTuple() [2/2]

    TupleValue& GetTuple ( Int  index,
    const TupleDataType type 
    )

    Returns a reference to the tuple value of the tuple member at index. The corresponding member type has to be a tuple data type.

    Parameters
    [in]indexIndex of the member.
    [in]typeTuple data type of this TupleValue.
    Returns
    Reference to the member value.