CB.GetAssum

This function retrieves information for a specific assumption cell. You can call this function from either a subroutine or a worksheet.

Note:

To call this function from a worksheet, use the name CB.GetAssumFN. Named constants do not work as arguments in worksheets. You must use the index number instead.

Note that the CB.GetAssum call is not retrieving the name and value of the third and fourth parameters properly for assumptions defined with alternate parameter sets of a beta distribution via CB.DefineAltParms.

For best results, call CB.CheckData before calling this function to ensure the latest data values are used.

Table 84. CB.GetAssum Returned Data Type

Returned Value	Returned Data Type
Some attribute or parameter for the assumption	Variant

Table 85. CB.GetAssum Parameters

Parameter	VBA Data Type	Value	Description
AssumReference	Variant	In a macro: Range("B3") In a worksheet: B3	Points to the desired assumption cell
Index	Integer	See Table 86	Retrieves information for a specific assumption cell using constant and index values listed in Table 86
ParmNumber (Optional)	Variant	1, 2, 3, 4	Specifies the target distribution parameter for Index equal to either cbAsmParmName or cbAsmParmValue

Parameter

VBA Data Type

Value

Description

AssumReference

Variant

In a macro: Range("B3")

In a worksheet: B3

Points to the desired assumption cell

Index

Integer

See Table 86

Retrieves information for a specific assumption cell using constant and index values listed in Table 86

ParmNumber (Optional)

Variant

1, 2, 3, 4

Specifies the target distribution parameter for Index equal to either cbAsmParmName or cbAsmParmValue

Note:

For hypergeometric distributions, whether the distribution was created in pre-7.0 releases with the Probability parameter or in later versions of Crystal Ball with the Success parameter, index 17 for cbDfaHypergeometricSuccess is always returned and the first parameter and value are Success, not Probability.

Table 86, following, shows named constant and index values for the Index parameter.

Note:

Index values cbAsmNumParms, cbAsmParmName, cbAsmParmValue, cbAsmLowCutOff, and cbAsmHighCutOff are not supported for custom distributions.

Table 86. CB.GetAssum Index Parameter Values — Required, Integer

Named Constant Value	Index Value	Description
cbAsmName	1	Returns the assumption name
cbAsmDistType	2	Returns the index value of the distribution type (See Table 53)
cbAsmNumParms	3	Returns the number of distribution parameters
cbAsmParmName	4	Returns the name of the distribution parameter indexed by ParmNumber
cbAsmParmValue	5	Returns the value of the distribution parameter indexed by ParmNumber
cbAsmLowCutOff	6	Returns the value of the lower truncation point
cbAsmHighCutOff	7	Returns the value of the higher truncation point
cbAsmDistFlag	8	Returns the extreme value distribution flag: 0=cbFlgMinimum, 1=cbFlgMaximum
cbAsmFrozen	10	Returns True if the assumption is frozen and False if it is not frozen
cbAsmIsSequential	11	Returns True if the assumption uses sequential sampling and False if it does not