CB.TwoDSimulationND

The 2D Simulation tool helps evaluate risk by estimating the uncertainty and variability for a given forecast using two-dimensional simulation. This call runs the 2D Simulation tool and displays results without using a dialog.

This call returns a variant.

Note:

Before calling CB.TwoDSimulationND, reset the Crystal Ball simulation.

Table 195. CB.TwoDSimulationND Parameters

Parameter

Required?

VBA Data Type

Table

Index

Required

Integer

Table 196

Value1

Optional

Integer

Table 197

Value2

Optional

Variant

Table 198

Table 196. CB.TwoDSimulationND Index Parameter – Required, Integer

Named Constant Value

Index

Description

cbTwoDChooseTarget

1

Sets the target forecast for the 2D simulation operation (operates on the forecast in the currently selected cell; use [cell].Select first to select the cell)

cbTwoDChooseAssum

2

Works with Value1 to choose assumptions for the uncertainty loop, the variability loop, or to clear the list (operates on the assumption in the currently selected cell; use [cell].Select first to select the cell)

cbTwoDOuterSimTrials

3

Used with Value1 to specify the number of trials in the outer (uncertainty) simulation loop

cbTwoDInnerSimTrials

4

Used with Value1 to specify the number of trials in the inner (variability) simulation loop

cbTwoDForeOption

5

Used with Value1 to set forecast chart window display options

cbTwoDOutputOption

6

Used with Value1 to set output report options

cbTwoDPercent

7

Used with Value1 to specify percentile settings

cbTwoDMSDOption

8

Used with Value1 to specify the maximum number of uncertainty simulations to display in the output report and overlay chart

cbTwoDRun

9

Runs the 2D Simulation tool

Table 197. CB.TwoDSimulationND Value1 Parameter – Optional, Integer

Related Value

Value or Named Constant

Index

Description

For Index = 2, cbTwoDChooseAssum: Integer

cbTwoDAddAssumUncert

1

Used with cbTwoDChooseAssum to add the selected assumption to the uncertainty simulation

For Index = 2, cbTwoDChooseAssum: Integer

cbTwoDAddAssumVar

2

Used with cbTwoDChooseAssum to add the selected assumption to the variability simulation

For Index = 2, cbTwoDChooseAssum: Integer

cbTwoDAssumClearList

3

Used with cbTwoDChooseAssum to return all unfrozen assumptions back to the uncertainty simulation

For Index = 3, cbTwoDOuterSimTrials

Positive whole number (integer)

n/a

Used with cbTwoDOuterSimTrials to specify the number of trials in the outer (uncertainty) simulation

For Index = 4, cbTwoDInnerSimTrials

Positive whole number (integer)

n/a

Used with cbTwoDInnerSimTrials to specify the number of trials in the inner (variability) simulation

For Index = 5, cbTwoDForeOption: Integer

cbTwoDShowDefineFore

1

Uses display settings for each forecast chart; the equivalent of the Show Forecasts As Defined dialog setting

For Index = 5, cbTwoDForeOption: Integer

cbTwoDShowTargetFore

2

Shows only the target forecast; the equivalent of the Show Only Target Forecast dialog settin

For Index = 5, cbTwo ForeOption: Integer

cbTwoDHideFore

3

Hides all forecasts; the equivalent of the Hide All Forecasts dialog setting

For Index = 6, cbTwoDOutputOption: Integer

cbTwoDShowForeStat

1

Used with cbTwoDOutputOption and a boolean Value parameter to specify whether to include forecast statistics in the output report; if followed by True, includes statistics in the report

For Index = 6, cbTwoDOutputOption: Integer

cbTwoDShowPercentiles

2

Used with cbTwoDOutputOption and a boolean Value parameter to specify whether to include percentiles in the output report; if followed by True, includes percentiles in the report

For Index = 6, cbTwoDOutputOption: Integer

cbTwoDShowCapMetrics

3

Used with cbTwoDOutputOption and a boolean Value parameter to specify whether to include capability metrics in the output report; if followed by True, includes capability metrics in the report

For Index = 7, cbTwoDPercent: Integer

cbTwoDPercentTenNinety

1

Specifies the 10th and 90th percentiles

For Index = 7, cbTwoDPercent: Integer

cbTwoDPercentFiveNinetyFive

2

Specifies the 5th and 95th percentiles

For Index = 7, cbTwoDPercent: Integer

cbTwoDPercentQuartiles

3

Specifies quartiles (25%-ile increments from 0 to 100, inclusive)

For Index = 7, cbTwoDPercent: Integer

cbTwoDPercentQuintiles

4

Specifies quintiles (20%-ile increments from 0 to 100, inclusive)

For Index = 7, cbTwoD Percent: Integer

cbTwoDPercentDeciles

5

Specifies deciles (10%-ile increments from 0 to 100, inclusive)

For Index = 7, cbTwoDPercent: Integer

cbTwoDPercentIcosatiles

6

Specifies icosatiles (5%-ile increments from 0 to 100, inclusive)

For Index = 7, cbTwoDPercent: Integer

cbTwoDPercentCustom

7

Defines custom percentiles, supplied by an optional Value entry (a one-dimensional cell range containing percentiles). If Value is omitted, the default percentiles are 2.5, 5, 50, 90, 95, 97.5.

For Index = 8, cbTwoDMSDOption: Integer

Integer from 2 to 250

n/a

Used with cbTwoDMSDOption to specify the maximum number of uncertainty simulations to display in the output report and overlay chart

Table 198. CB.TwoDSimulationND Value2 Parameter – Optional, Variant

Related Value

Value or Named Constant

VBA Data Type

Index

Description

For Index = 6, cbTwoDOutputOption: Integer

True or False

Boolean

n/a

Indicates whether to activate the specified Value1 constant; if set to True, includes the specified items in the output report

For Value1 = cbTwoDPercentCustom

A string containing a Microsoft Excel range that holds desired percentile values. The values must be entered into Microsoft Excel as numbers, not formatted as percentages; can be decimals.

String

n/a

Specifies custom percentile values to analyze