HsvMDDataBuffer Object Overview

The HsvMDDataBuffer object supplements the HsvData object by providing methods to manage arrays of cells, caching the cells’ subcubes to RAM. Note that the cells in an HsvMDDataBuffer object are not stored in an application.

The HsvData object provides the following methods to move data between an application and an HsvMDDataBuffer object:

Create HsvMDDataBuffer object references with the following syntax. Note that you must include the New keyword, otherwise an error will occur:

  Dim cHsvMDDataBuffer As HsvMDDataBuffer
  Set cHsvMDDataBuffer = New HSVMDARRAYSLib.HsvMDDataBuffer

The following table summarizes the HsvMDDataBuffer object’s methods.

Table 31. HsvMDDataBuffer Object Methods

Method

Description

BeginEnumeration

Locks an HsvMDDataBuffer object, and returns the number of subcubes contained by the object.

CreateDataIndexList

Creates an HsvMDIndexList object based upon the items in an HsvMDDataBuffer object.

CreateDataIndexListExFor internal use.

EndEnumeration

Unlocks an HsvMDDataBuffer object that has been locked by BeginEnumeration.

EraseRecordFromPMBufferFor internal use.

GetCheckLineItemDetailsForCaseInsensitiveDuplicates

Indicates whether case-insensitive duplicate checking is enabled for the HsvMDDataBuffer instance.

GetCubeIndexFromPOV

Returns the index of a subcube in an HsvMDDataBuffer object, given the IDs of the subcube’s dimension members.

GetCubePOVFromIndex

Returns the IDs of a subcube’s dimension members, given the subcube’s index.

GetData

Returns a cell’s data, given the member IDs that identify the cell.

GetDataAtIndex

Returns the data for a cell, given the indexes that identify the cell.

GetDescription

Returns a cell’s description, given the member IDs that identify the cell.

GetDescriptionAtIndex

Returns the description for a cell, given the indexes that identify the cell.

GetLineItems

Returns the data and descriptions for a cell’s line items, given the IDs that identify the cell’s dimension members.

GetLineItemsAtIndex

Returns the data and descriptions for a cell’s line items, given the indexes that identify the cell.

GetNumCellsForData

Returns the number of cells that are in a period of a subcube and that contain data.

GetNumCellsForDescriptions

Returns the number of cells that are in a period of a subcube and that contain descriptions.

GetNumCellsForLineItems

Returns the number of cells that are in a period of a subcube and that contain line items.

GetNumPeriodsInCubeForData

Returns the number of periods that are in a subcube and that contain cells with data.

GetNumPeriodsInCubeForDescriptions

Returns the number of periods that are in a subcube and that contain cells with descriptions.

GetNumPeriodsInCubeForLineItems

Returns the number of periods that are in a subcube and that contain cells with line items.

GetPeriodIndexFromPOVForData

Returns the index of a period within a subcube, given the subcube’s index and the period’s member ID. An index is returned only for periods with cells that contain data.

GetPeriodIndexFromPOVForDescriptions

Returns the index of a period within a subcube, given the subcube’s index and the period’s member ID. An index is returned only for periods with cells that contain descriptions.

GetPeriodIndexFromPOVForLineItems

Returns the index of a period within a subcube, given the subcube’s index and the period’s member ID. An index is returned only for periods with cells that contain line items.

GetPeriodPOVFromIndexForData

Returns the member ID of a period, given a subcube index and a period index. IDs are returned only for periods with cells that contain data.

GetPeriodPOVFromIndexForDescriptions

Returns the member ID of a period, given a subcube index and a period index. IDs are returned only for periods with cells that contain descriptions.

GetPeriodPOVFromIndexForLineItems

Returns the member ID of a period, given a subcube index and a period index. IDs are returned only for periods with cells that contain line items.

GetPMErrorRecordCountFor internal use.
GetPMRecordCountFor internal use.
GetRecordFromPMBufferFor internal use.
GetRecordFromPMErrorBufferFor internal use.

GetSortedNature

For internal use.

InsertDataAtBeginning

Inserts data for a cell at the top of an HsvMDDataBuffer object.

InsertDataAtEnd

Inserts data for a cell at the bottom of an HsvMDDataBuffer object.

InsertDescriptionAtBeginning

Inserts a cell description at the top of an HsvMDDataBuffer object.

InsertDescriptionAtEnd

Inserts a cell description at the bottom of an HsvMDDataBuffer object.

InsertLineItemsAtBeginning

Inserts line items for a cell at the top of an HsvMDDataBuffer object.

InsertLineItemsAtEnd

Inserts line items for a cell at the bottom of an HsvMDDataBuffer object.

InsertRecordIntoPMBufferFor internal use.
InsertRecordIntoPMErrorBufferFor internal use.

RemoveAll

Clears all the cells from an HsvMDDataBuffer object.

SetCheckLineItemDetailsForCaseInsensitiveDuplicates

Specifies whether the system should check for case-insensitive duplicate line item descriptions.

SetData

Inserts a cell’s data into an HsvMDDataBuffer object.

SetDescription

Inserts a cell’s description into an HsvMDDataBuffer object.

SetGrowByAmount

Changes the amount of memory that the HsvMDDataBuffer object automatically allocates.

SetLineItems

Inserts a cell’s line items into an HsvMDDataBuffer object.

SetSortedNature

For internal use.

Sort

For internal use.