ICalendarDimensionClass.HalfYear

HalfYear(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 HalfYear method returns index of the element that corresponds to the half-year containing the specified element.

Comments

For correct calculation the calendar dictionary must contain the Half-years level. If the level is missing, the method returns -1.

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

Element of the annual frequency, the HalfYear method returns the element corresponding to the first half-year.
Element of the Quarterly frequency, the HalfYear method returns the element corresponding to the half-year, which includes 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.

Function HalfYear(T: Variant): Integer;
Var
    Cube: ICubeInstance;
    CubeDest: ICubeInstanceDestination;
    DimInsts: ICubeInstanceDimensions;
    DimInst: IDimInstance;
    i: Integer;
    Result: 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
    If CalendarDimension.Level(DimInst, t) = DimCalendarLevel.Year Then
        Result := CalendarDimension.HalfYear(DimInst, t);
    Else
        Result := -1;
    End If;
    // Return result
    Return Result;
End Function HalfYear;

The result of using the relation in the formula of the calculated fact: the value for the element of the annual frequency will be taken from the first half-year.