Article
05/23/2011

Tuple Class

Represents an ordered collection of members from different hierarchies.

Inheritance Hierarchy

System.Object
Microsoft.AnalysisServices.AdomdClient.Tuple

Namespace: Microsoft.AnalysisServices.AdomdClient
Assembly: Microsoft.AnalysisServices.AdomdClient (in Microsoft.AnalysisServices.AdomdClient.dll)

Syntax

'Declaration
Public NotInheritable Class Tuple
'Usage
Dim instance As Tuple

public sealed class Tuple

public ref class Tuple sealed

[<SealedAttribute>]
type Tuple =  class end

public final class Tuple

The Tuple type exposes the following members.

Properties

	Name	Description
	Members	Gets an instance of the MemberCollection class from the Tuple.
	TupleOrdinal	Gets the ordinal position of the Tuple.

Top

Methods

	Name	Description
	Equals	Determines whether two instances of System.Object are equal. (Overrides Object.Equals(Object).)
	Finalize	(Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type, for use in hashing algorithms and data structures such as hash tables. (Overrides Object.GetHashCode().)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

Operators

	Name	Description
	Equality	Determines whether two specified instances of Tuple are equal.
	Inequality	Determines whether two specified instances of Tuple are not equal.

Top

Remarks

A tuple consists of an ordered collection of members.

A tuple cannot contain more than one member from any single hierarchy.

In ADOMD.NET, a Tuple is used to represent a tuple by encapsulating the collection of Member objects that define the tuple. Tuple objects can be referenced only through the Tuples property of a Set.

Examples

The following function, given a Tuple, examines the object and returns a Multidimensional Expressions (MDX) string representation of the tuple:

Public Function GetTupleString(ByRef TupleToConvert As Tuple) As String
    If TupleToConvert Is Nothing Then
        Throw New System.ArgumentNullException("TupleToConvert")
    Else
        Dim tupleCount As Integer = TupleToConvert.Members.Count
        Dim tupleIndex As Integer = 0

        If tupleCount = 0 Then
            ' An empty tuple.
            Return "()"
        Else
            ' Iterate through each member in the Members collection,
            ' adding the value of the UniqueName property to a
            ' string.
            ' Because a tuple can represent many members, this
            ' example uses a StringBuilder object to improve
            ' string handling performance.
            Dim tupleString As New _
                System.Text.StringBuilder(15 * tupleCount)

            ' Tuples are framed with parentheses, with each member
            ' within a tuple separated by a comma.
            tupleString.Append("(")
            For tupleIndex = 0 To tupleCount - 1
                tupleString.Append( _
                TupleToConvert.Members(tupleIndex).UniqueName)
                If tupleIndex < (tupleCount - 1) Then
                    tupleString.Append(", ")
                End If
            Next
            tupleString.Append(")")

            Return tupleString.ToString
        End If
    End If
End Function

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via