Article
05/23/2011

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
	AggregationInstance()	Initializes a new instance of the AggregationInstance class using the default values.
	AggregationInstance(String)	Initializes a new instance of the AggregationInstance class using a name.
	AggregationInstance(String, String)	Initializes a new instance of the AggregationInstance class using a name and an identifier.

Top

Properties

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

Top

Methods

	Name	Description
	AddToContainer	Infrastructure. (Inherited from ModelComponent.)
	AfterInsert	Infrastructure. (Inherited from ModelComponent.)
	AfterMove	Infrastructure. (Inherited from ModelComponent.)
	AfterRemove	Infrastructure. (Inherited from ModelComponent.)
	BeforeRemove	Infrastructure. (Inherited from ModelComponent.)
	Clone	Creates a new, full copy of an object.
	CopyTo(AggregationInstance)	Copies an AggregationInstance to the specified object.
	CopyTo(ModelComponent)	Infrastructure. (Inherited from ModelComponent.)
	CopyTo(NamedComponent)	(Inherited from NamedComponent.)
	CreateObjRef	(Inherited from MarshalByRefObject.)
	Dispose()	(Inherited from Component.)
	Dispose(Boolean)	(Inherited from Component.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Component.)
	GetHashCode	(Inherited from Object.)
	GetLifetimeService	(Inherited from MarshalByRefObject.)
	GetService	(Inherited from Component.)
	GetType	(Inherited from Object.)
	InitializeLifetimeService	(Inherited from MarshalByRefObject.)
	MemberwiseClone()	(Inherited from Object.)
	MemberwiseClone(Boolean)	(Inherited from MarshalByRefObject.)
	RemoveFromContainer	Infrastructure. (Inherited from ModelComponent.)
	Reset	(Inherited from NamedComponent.)
	Submit()	Infrastructure. (Inherited from ModelComponent.)
	Submit(Boolean)	Infrastructure. (Inherited from ModelComponent.)
	ToString	(Inherited from NamedComponent.)
	Validate(ValidationErrorCollection)	Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
	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.)
	Validate(ValidationErrorCollection, Boolean, ServerEdition)	(Inherited from NamedComponent.)

Top

Events

	Name	Description
	Disposed	(Inherited from Component.)

Top

Explicit Interface Implementations

	Name	Description
	ICloneable.Clone
	IFormattable.ToString	(Inherited from NamedComponent.)
	IHostableComponent.Host	(Inherited from ModelComponent.)
	IModelComponent.FriendlyPath	(Inherited from ModelComponent.)
	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.

Share via