Initializing help system before first use

# problem.addSlpCascadeStartCallback

Purpose
Add a user callback to be called at the start of the cascading process, before any variables have been cascaded
Topic areas
Callback, SLP, Cascading
Synopsis
`problem.addSlpCascadeStartCallback(slpcascadestart, data=None, priority=0)`
`result = slpcascadestart(cbprob, cbdata)`
Arguments

slpcascadestart | The function to be called at the start of the cascading process. slpcascadestart returns an integer value. If the return value is nonzero, the cascading process will be omitted for the current SLP iteration, but the optimization will continue.
data: Any | A user-defined object, which can be used for any purpose by the function. data is passed to slpcascadestart as cbdata.
priority: int | An integer that determines the order in which callbacks of this type will be invoked. The callback added with a higher priority will be called before a callback with a lower priority. Set to 0 if not required.
cbprob: problem | The problem passed to the callback function.
cbdata: Any | The user-defined object passed as data to problem.addSlpCascadeStartCallback.

Return value

result: int | The result of the callback

Further information
This callback can be used at the start of the cascading, before any of the solution values have been recalculated.
Related topics
problem.slpCascadeSol, problem.addSlpCascadeEndCallback, problem.addSlpCascadeVarCallback, problem.addSlpCascadeVarFailCallback problem.removeSlpCascadeStartCallback
Parent Topic Xpress problem object methods

© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.