ICalendarDimensionClass.UpLevel

Syntax

UpLevel(Calendar: IDimInstance; El: Integer): Integer;

Parameters

Calendar. Data of the calendar dictionary, by which calculation is executed.

El. Index of the element, relative to which calculation is executed.

Description

The UpLevel method returns index of the element, which is a parent for the specified element.

Comments

If the child element is missing, the method returns -1.

For example, if the calendar dictionary contains Years, Quarters, Months levels and the calculation is executed for:

Element of the annual frequency, the UpLevel method returns the element corresponding to the first quarter of the year.
Element of the quarter frequency, the UpLevel method returns the element corresponding to the first month of the quarter.

Example

The example is the function that is used to calculate the relation in a standard cube.

To execute the example, add links to the Cubes and Dimensions system assemblies.

Public Function UpLevel(T: Variant): Integer;
Var
    Cube: ICubeInstance;
    CubeDest: ICubeInstanceDestination;
    DimInsts: ICubeInstanceDimensions;
    DimInst: IDimInstance;
    i: Integer;
    Result: Integer;
    el1: Integer;
Begin
    // Get the current cube
    Cube := CubeClass.CurrentCube;
    CubeDest := Cube.Destinations.DefaultDestination;
    // Get calendar dimension
    DimInsts := CubeDest.Dimensions;
    For i := 0 To DimInsts.Count - 1 Do
        If (DimInsts.Item(i).Dimension Is ICalendarDimension) Then
            DimInst := DimInsts.Item(i);
        End If;
    End For;
    // Execute calculation
    el1 := CalendarDimension.UpLevel(DimInst, t);
    Result := CalendarDimension.IifLevel(DimInst, t, DimCalendarLevel.Year, el1, t);
    // Return result
    Return Result;
End Function UpLevel;

The result of using the relation in the formula of the calculated fact: the value for the elements of annual frequency will be taken from value of the elements corresponding to the first quarters.