TupleCollection Class

 

Updated: March 10, 2016

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)

System.Object
  Microsoft.AnalysisServices.AdomdClient.TupleCollection

public sealed class TupleCollection : ICollection, IEnumerable

NameDescription
System_CAPS_pubpropertyCount

Gets the number of Tuple objects in the collection.

System_CAPS_pubpropertyIsSynchronized

Gets a value indicating whether access to the collection is synchronized (thread safe).

System_CAPS_pubpropertyItem[Int32]

Gets the specified Tuple from the collection by its index. In C#, this property is the indexer for the TupleCollection class.

System_CAPS_pubpropertySyncRoot

Gets a System.Object that can be used to synchronize access to the collection.

NameDescription
System_CAPS_pubmethodCopyTo(Tuple[], Int32)

Copies the elements of the collection to the specified array.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Gets an Enumerator for iterating through the collection.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection.CopyTo(Array, Int32)

Copies the elements of the TupleCollection to the specified array, starting at a particular array index.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable.GetEnumerator()

Gets 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")
    Else
        ' Iterate through the Tuples collection of the
        ' Set object. 
        Try
            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: " & _
                        tupleToCheck.TupleOrdinal)
                    Debug.WriteLine("  No. of members:    " & _
                        tupleToCheck.Members.Count)
                Next
            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.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As AdomdErrorResponseException
            ' A response is received from a provider which indicates an error.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As AdomdUnknownResponseException
            ' A response has been returned from the provider that 
            ' was not understood.
            Debug.WriteLine(ex)
            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.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As AdomdException
            ' Any other error raised by ADOMD.NET.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As Exception
            ' Any other error.
            Debug.WriteLine(ex)
            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.

Return to top
Show: