Cube Manipulation TurboIntegrator Functions

These functions pertain to manipulating cubes.

AddCubeDependency
AddCubeDependency lets you predefine cube inter-dependencies to avoid lock contention problems during normal system use.
CellGetN
CellGetN retrieves a value from a numeric cube cell.
CellGetS
CellGetS retrieves a value from a string cube cell.
CellIncrementN
CellIncrementN increments an existing numeric cell value by a specified value.
CellIsUpdateable
CellIsUpdateable determines whether a cube cell can be written to. The function returns 1 if the cell can be written to, otherwise it returns 0.
CellPutN
CellPutN sends a numeric value to a cube cell.
CellPutProportionalSpread
CellPutProportionalSpread distributes a specified value to the leaves of a consolidation proportional to existing cell values. CellPutProportionalSpread replaces existing cell values; it cannot be used to add to or subtract from existing cell values.
CellPutS
CellPutS sends a string value to a cube cell.
CubeClearData
CubeClearData clears all of the data in a cube. This function is much faster than doing an operation such as creating a view to cover the entire cube, and then doing a ViewZeroOut() to zero out the entire cube.
CubeCreate
CubeCreate creates a cube from specified dimensions. The order of dimensions specified in the function will be the order of dimensions in the cube definition. After execution, CubeCreate automatically saves the resulting .cub file to disk.
CubeDestroy
CubeDestroy deletes a specified TM1® cube.
CubeDimensionCountGet
CubeDimensionCountGet returns the number of dimensions in a cube.
CubeExists
CubeExists determines whether a specific cube exists on the server from which a TurboIntegrator process is executed. The function returns 1 if the cube exists on the server, otherwise it returns 0.
CubeGetLogChanges
CubeGetLogChanges returns the Boolean value of the Logging property for a specified cube.
CubeSaveData
CubeSaveData() serializes a cube.
CubeSetConnParams
CubeSetConnParams is used to encrypt the password for a virtual cube in the }CubeProperties cube.
CubeSetLogChanges
CubeSetLogChanges sets the Logging property for a cube.
CubeTimeLastUpdated
CubeTimeLastUpdated returns a serial value that indicates the date and time at which a specified cube was last updated.
CubeUnload
CubeUnload unloads a specified cube, along with all associated cube views, from memory.

Parent topic: TurboIntegrator Functions