CB.AutoDownshift

This call specifies whether to automatically “downshift” to Normal speed when a simulation cannot run in Extreme speed and returns the current setting. This setting is global. It is in place for the entire Crystal Ball session. The default setting is True, which switches automatic downshift on. If CB.AutoDownshift is set to False and a simulation cannot run in Extreme speed, the simulation fails and an error is returned. CB.MacroResultDetail (CB.MacroResultDetail) can return the reason for the failure.

Note:

If CB.AutoDownshift is not called, Crystal Ball acts as if it has been called with the default setting of True. That is, if a simulation cannot run in Extreme speed, it is automatically downshifted to Normal speed and nothing is recorded in the error log because the simulation ran successfully. You can test whether a simulation can run in Extreme speed by causing the simulation to fail when it cannot run in Extreme speed. To perform the test, explicitly call CB.AutoDownshift and set it to False.

Table 7. CB.AutoDownshift Returned Data Type

Returned Value

Returned Data Type

The current TurnOn parameter setting

Boolean

Table 8. CB.AutoDownshift Parameters

Parameter

VBA Data Type

Named Constant Value

Description

TurnOn

Variant

True or False

True turns on automatic downshifting from Extreme speed to Normal speed. False turns it off.