IMsMatrixAggregationTransform

The IMsMatrixAggregationTransform interface is used to set up calculation parameters of the model that performs matrix aggregation.

Inheritance Hierarchy

Comments

Features of Aggregation Calculation

If there are breaks in the selection, data is aggregated with jump to the level. A selection break occurs when child elements are selected, but their parent elements are no selected. In this case data of child elements of the non-selected parent element is used to calculate the next parent element.

For example, there is the hierarchy, in which there are breaks in elements selection:

Calculation can be executed in different ways:

Data is aggregated with jump to the level as follows:

Step	The Include Owner Value checkbox is selected	The Include Owner Value checkbox is deselected
Lower level value is calculated
	Item 1.1 = Item 1.1 + item 1.1.1 + item 1.1.2	Item 1.1 = item 1.1.1 + item 1.1.2
Upper level value is calculated
	Item 2 = Item 2+ item 2.1.1 + 2.1.2	Item 2 = item 2.1.1 + 2.1.2
	Item 3 = Item 3 + item 3.1.1	Item 3 = item 3.1.1
Root element value is calculated
	Root = Root + item 1.1 + item 1.3 + item 2 + item 3	Root = item 1.1 + item 1.3 + item 2 + item 3

Properties

Properties inherited from IMsMethod

	Property name	Brief description
	CalculateSeries	The CalculateSeries property returns results of model calculation.
	Inversion	Outdated. Use InversionInfo.Inversion.
	InversionInfo	The InversionInfo property returns parameters of initial transformation applied to variable.
	InversionLag	Outdated. Use InversionInfo.InversionLag.
	ObservationsCount	The ObservationsCount property returns the number of model observations.
	PeriodAlignment	The PeriodAlignment property returns type of model calculation relative to period.
	PreviousInversionLag	Outdated. Use InversionInfo.PreviousInversionLag.
	Series	The Series property returns a set of available series used by current method in calculations.
	StatMethod	The StatMethod property returns information on statistical method used for model calculation.
	Summary	The Summary property returns summary statistics calculated for model.
	SupportsR	The SupportsR property determines whether calculation by R is enabled.
	Type	The Type property returns type of method used for model calculation.
	UseR	The UseR property determines whether connection to R is used on method calculation.

	Property name	Brief description
	Aggregator	The Aggregator property returns aggregation parameters for the specified dimension
	Filter	The Filter property returns the collection of aggregation filters.
	Result	The Result property returns the term corresponding to output variable.

	Method name	Brief description
	Execute	The Execute method calculates model and returns calculation results.