Measure Class

Article
02/01/2013

Represents a measure within a cube or measure group.

Inheritance Hierarchy

System.Object
Microsoft.AnalysisServices.AdomdClient.Measure

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

Syntax

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

public sealed class Measure

public ref class Measure sealed

[<SealedAttribute>]
type Measure =  class end

public final class Measure

The Measure type exposes the following members.

Properties

	Name	Description
	Caption	Gets the caption of the Measure.
	Description	Gets the description of the Measure.
	DisplayFolder	This member is reserved for future use.
	Expression	Gets the Multidimensional Expressions (MDX) expression that is used to aggregate the Measure.
	Name	Gets the name of the Measure.
	NumericPrecision	Gets the numeric precision value for the Measure.
	NumericScale	Gets the numeric scale for the Measure.
	ParentCube	Gets a CubeDef that contains the Measure.
	Properties	Gets an AdomdPropertyCollection that contains the properties associated with the Measure.
	UniqueName	Gets the unique name of the Measure.
	Units	Gets a description of the unit of measure for the Measure.

Top

Methods

	Name	Description
	Equals	Determines whether two instances of Measure are equal. (Overrides Object.Equals(Object).)
	GetHashCode	Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures such as hash tables. (Overrides Object.GetHashCode().)
	GetType	(Inherited from Object.)
	ToString	Returns a String that represents the current instance of the Measure. (Overrides Object.ToString().)

Top

Operators

	Name	Description
	Equality	Determines whether two instances of Measure are equal.
	Inequality	Determines whether two instances of Measure are unequal.

Top

Remarks

A measure represents the data within a fact table that is being organized and aggregated by the cube.

In ADOMD.NET, the Measure represents the metadata for a measure within a cube. A measure is not explicitly identified in a cellset, because a measure is treated as a member for querying purposes and is represented by a Measure within the Measures collection of a CubeDef.

Examples

The following subroutine, given a CubeDef, iterates through the Measures collection and displays information for each Measure:

Public Sub ListMeasures(ByRef CubeToCheck As CubeDef)

    ' Check the parameter before performing actions on it.
    If CubeToCheck Is Nothing Then
        Throw New System.ArgumentNullException("CubeToCheck")
    Else
        ' Iterate through the Measures collection of the
        ' CubeDef object.

        Try
            Dim measureToCheck As Measure

            Debug.WriteLine("Found " & CubeToCheck.Measures.Count & _
                " measure(s) in cube:")

            For Each measureToCheck In CubeToCheck.Measures
                Debug.WriteLine("Measure:  " & measureToCheck.Name)
                Debug.WriteLine("  Caption:        " & _
                    measureToCheck.Caption)
                Debug.WriteLine("  Description:    " & _
                    measureToCheck.Description)

            Next
        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

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