Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

TupleCollection Class

Gets a read-only collection of Tuple objects contained by a Set.


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

public sealed class TupleCollection : ICollection, 

The TupleCollection type exposes the following members.

Public propertyCountGets the number of Tuple objects in the collection.
Public propertyIsSynchronizedGets a value indicating whether access to the collection is synchronized (thread safe).
Public propertyItemGets the specified Tuple from the collection by its index. In C#, this property is the indexer for the TupleCollection class.
Public propertySyncRootGets a Object that can be used to synchronize access to the collection.

Public methodCopyToCopies the elements of the collection to the specified array.
Public methodEquals (Inherited from Object.)
Public methodGetEnumeratorGets an Enumerator for iterating through the collection.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodToString (Inherited from Object.)

Explicit interface implemetationPrivate methodICollection.CopyToCopies the elements of the TupleCollection to the specified array, starting at a particular array index.
Explicit interface implemetationPrivate methodIEnumerable.GetEnumeratorGets the enumerator that iterates through the TupleCollection.

The following subroutine, given a CellSet and the total number of cells for which information should be displayed, iterates through the Tuples collection and displays information for each tuple:

Public Sub ListTupleCollection(ByRef AxisToCheck As Axis, _
    Optional ByVal Count As Integer = 10)

    ' Because a Set object can represent thousands of tuples,
    ' the Count parameter limits the output to a 
    ' specified number of cells.

    ' Check the parameter before performing actions on it.
    If AxisToCheck Is Nothing Then
        Throw New System.ArgumentNullException("AxisToCheck")
        ' Iterate through the Tuples collection of the
        ' Set object. 
            Dim tupleToCheck As Tuple
            Dim tupleCount As Integer
            Dim tupleIndex As Integer

            tupleCount = AxisToCheck.Set.Tuples.Count

            Debug.WriteLine("Found " & tupleCount & _
                " tuple(s) in axis:")

            If tupleCount > Count Then tupleCount = Count
            If tupleCount > 0 Then
                For tupleIndex = 0 To tupleCount
                    tupleToCheck = AxisToCheck.Set.Tuples(tupleIndex)
                    Debug.WriteLine("Tuple: " & _
                    Debug.WriteLine("  No. of members:    " & _
            End If
        Catch ex As AdomdConnectionException
            ' The connection could not be opened or was disconnected.
            ' This error can occur at any time, if the provider is 
            ' disconnected from the server.
            Throw ex
        Catch ex As AdomdErrorResponseException
            ' A response is received from a provider which indicates an error.
            Throw ex
        Catch ex As AdomdUnknownResponseException
            ' A response has been returned from the provider that 
            ' was not understood.
            Throw ex
        Catch ex As AdomdCacheExpiredException
            ' A cached version of an ADOMD.NET object is no longer valid.
            ' This error is typically raised when reviewing metadata.
            Throw ex
        Catch ex As AdomdException
            ' Any other error raised by ADOMD.NET.
            Throw ex
        Catch ex As Exception
            ' Any other error.
            Throw ex
        End Try
    End If
End Sub

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

Community Additions

© 2015 Microsoft