AggregationInstance Class

Represents an instance of a defined Aggregation for a partition.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.AnalysisServices.ModelComponent
        Microsoft.AnalysisServices.NamedComponent
          Microsoft.AnalysisServices.AggregationInstance

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

Syntax

'Declaration
<GuidAttribute("22940FE2-7C38-4243-9996-2FC8054500B2")> _
Public Class AggregationInstance _
    Inherits NamedComponent _
    Implements ICloneable
'Usage
Dim instance As AggregationInstance
[GuidAttribute("22940FE2-7C38-4243-9996-2FC8054500B2")]
public class AggregationInstance : NamedComponent, 
    ICloneable
[GuidAttribute(L"22940FE2-7C38-4243-9996-2FC8054500B2")]
public ref class AggregationInstance : public NamedComponent, 
    ICloneable
[<GuidAttribute("22940FE2-7C38-4243-9996-2FC8054500B2")>]
type AggregationInstance =  
    class
        inherit NamedComponent
        interface ICloneable
    end
public class AggregationInstance extends NamedComponent implements ICloneable

The AggregationInstance type exposes the following members.

Constructors

  Name Description
Public method AggregationInstance() Initializes a new instance of the AggregationInstance class using the default values.
Public method AggregationInstance(String) Initializes a new instance of the AggregationInstance class using a name.
Public method AggregationInstance(String, String) Initializes a new instance of the AggregationInstance class using a name and an identifier.

Top

Properties

  Name Description
Public property AggregationType Defines the type of aggregation stored in AggregationInstance.
Public property Annotations Gets a collection within which you can store custom data. (Inherited from ModelComponent.)
Protected property CanRaiseEvents (Inherited from Component.)
Public property Container (Inherited from Component.)
Public property Description (Inherited from NamedComponent.)
Protected property DesignMode (Inherited from Component.)
Public property Dimensions Returns the collection of dimensions associated with an AggregationInstance.
Protected property Events (Inherited from Component.)
Protected property FriendlyName (Inherited from NamedComponent.)
Public property ID (Inherited from NamedComponent.)
Protected property KeyForCollection (Inherited from NamedComponent.)
Public property Measures Gets the collection of measures associated with an AggregationInstance.
Public property Name (Inherited from NamedComponent.)
Public property OwningCollection Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
Public property Parent Infrastructure. (Inherited from ModelComponent.)
Public property Site (Inherited from NamedComponent.)
Public property SiteID (Inherited from NamedComponent.)
Public property Source Gets or sets the table name for the aggregation, if different than the table associated with column binding.

Top

Methods

  Name Description
Protected method AddToContainer Infrastructure. (Inherited from ModelComponent.)
Protected method AfterInsert Infrastructure. (Inherited from ModelComponent.)
Protected method AfterMove Infrastructure. (Inherited from ModelComponent.)
Protected method AfterRemove Infrastructure. (Inherited from ModelComponent.)
Protected method BeforeRemove Infrastructure. (Inherited from ModelComponent.)
Public method Clone Creates a new, full copy of an object.
Public method CopyTo(AggregationInstance) Copies an AggregationInstance to the specified object.
Protected method CopyTo(ModelComponent) Infrastructure. (Inherited from ModelComponent.)
Protected method CopyTo(NamedComponent) (Inherited from NamedComponent.)
Public method CreateObjRef (Inherited from MarshalByRefObject.)
Public method Dispose() (Inherited from Component.)
Protected method Dispose(Boolean) (Inherited from Component.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Component.)
Public method GetHashCode (Inherited from Object.)
Public method GetLifetimeService (Inherited from MarshalByRefObject.)
Protected method GetService (Inherited from Component.)
Public method GetType (Inherited from Object.)
Public method InitializeLifetimeService (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() (Inherited from Object.)
Protected method MemberwiseClone(Boolean) (Inherited from MarshalByRefObject.)
Protected method RemoveFromContainer Infrastructure. (Inherited from ModelComponent.)
Protected method Reset (Inherited from NamedComponent.)
Public method Submit() Infrastructure. (Inherited from ModelComponent.)
Public method Submit(Boolean) Infrastructure. (Inherited from ModelComponent.)
Public method ToString (Inherited from NamedComponent.)
Public method Validate(ValidationErrorCollection) Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
Public method Validate(ValidationErrorCollection, Boolean) Validates the element to which it is appended; returns any errors encountered in a collection. Also contains a parameter to enable return of detailed errors. (Inherited from ModelComponent.)
Public method Validate(ValidationErrorCollection, Boolean, ServerEdition) (Inherited from NamedComponent.)

Top

Events

  Name Description
Public event Disposed (Inherited from Component.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICloneable.Clone
Explicit interface implemetationPrivate method IFormattable.ToString (Inherited from NamedComponent.)
Explicit interface implemetationPrivate property IHostableComponent.Host (Inherited from ModelComponent.)
Explicit interface implemetationPrivate property IModelComponent.FriendlyPath (Inherited from ModelComponent.)
Explicit interface implemetationPrivate property IModelComponent.OwningCollection (Inherited from ModelComponent.)

Top

Remarks

When a Partition uses an AggregationDesign to generate aggregations for that partition, each Aggregation in the AggregationDesign is instantiated for that partition. Multiple partitions can use the same AggregationDesign to generate multiple instances of a defined Aggregation. Also note that user defined aggregations can be created on a partition without going through the AggregationDesign object.

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.