CubeDefn Class Methods
The following section discusses the CubeDefn class methods. The methods are discussed in alphabetical order.
Syntax
AttachDimension(DimName)
Description
Use the AttachDimension method to attach an existing dimension specified by DimName to the cube.
Parameters
|
Field or Control |
Definition |
|---|---|
| DimName |
Specify the name of the dimension that you want to add. |
Returns
None.
Syntax
DetatchDimension(DimName)
Description
Use the DetachDimension method to detach the dimension specified by DimName from the cube.
Parameters
|
Field or Control |
Definition |
|---|---|
| DimName |
Specify the name of the dimension that you want to detach from the cube. |
Returns
None.
Syntax
GetCauses(CauseType)
Description
Any cube that affects another cube is a cause of that cube. Use the GetCauses method to return a list of all the other cubes that are the causes for this cube.
The cube names are returned in an array of string.
Parameters
|
Field or Control |
Definition |
|---|---|
| CauseType |
Specify the type of causes you want returned. |
|
Value |
Description |
|---|---|
|
AnalyticModel_DirectCauses |
Only return direct causes. |
|
AnalyticModel_AllCauses |
Return all cubes that are causes for this cube, both direct and indirect. |
|
AnalyticModel_AllInputs |
Return all cubes that have input to this cube. |
Returns
An array of string.
Syntax
GetCircularDeps(DimName)
Description
Use the GetCircularDeps method to return all cubes that have circular dependencies based on the dimension specified by DimName.
The cube names are returned in an array of string.
Parameters
|
Field or Control |
Definition |
|---|---|
| DimName |
Specify the name of the dimension that you want to find circular dependencies for. |
Returns
An array of string.
Syntax
GetDimensionAggregate(DimName)
Description
Use the GetDimensionAggregate method to return the name of the user function used for the aggregate for the dimension specified by DimName.
Parameters
|
Field or Control |
Definition |
|---|---|
| DimName |
Specify the name of the dimension that you want the aggregate user function. |
Returns
A string.
Syntax
GetEffects(EffectType)
Description
Any cube that is affected by another cube is an effect of that cube. Use the GetEffects method to return a list of all the cubes affected by this cube.
The list of cubes is returned as an array of string.
Parameters
|
Field or Control |
Definition |
|---|---|
| EffectType |
Specify the type of effects you want returned. |
|
Value |
Description |
|---|---|
|
AnalyticModel_DirectEffects |
Only return cubes that are a direct effect on this cube. |
|
AnalyticModel_AllEffects |
Return all cubes that are an effect on this cube. |
Returns
An array of string.
Syntax
GetDimensionNames()
Description
Use the GetDimensionNames method to return an array of string containing the names of all the dimensions associated with the cube.
Parameters
None.
Returns
An array of string.
Syntax
GetRule()
Description
Use the GetRule method to get a reference to a RuleDefn object that represents the rule for this cube.
Parameters
None.
Returns
A RuleDefn object.
Syntax
SetDimensionAggregate(DimName, UserFunctionName)
Description
Use the SetDimensionAggregate method to specify the user function to be used for the aggregate for the dimension DimName.
Parameters
|
Field or Control |
Definition |
|---|---|
| DimName |
Specify the name of the dimension for which you want to set the aggregate. |
| UserFunctionName |
Specify the name of the user function to be used as the aggregate function. |
Returns
None.
Syntax
SetRule(&RuleDefn)
Description
Use the SetRule method to specify a RuleDefn object to be used as the rule for this cube.
Parameters
|
Field or Control |
Definition |
|---|---|
| &RuleDefn |
Specify an already instantiated RuleDefn object that you want to associate with this cube. |
Returns
None.
Syntax
UsesDimension(DimName)
Description
Use the UsesDimension method to determine if the dimension specified by DimName is used by this cube.
Parameters
|
Field or Control |
Definition |
|---|---|
| DimName |
Specify the name of the dimension that you want to check for. |
Returns
A Boolean value: true if the dimension is used, false otherwise.