Initializing help system before first use

# problem.addCheckTimeCallback

Purpose
Declares a callback function which is called every time the Optimizer checks if the time limit has been reached. This callback function will be called in addition to any callbacks already added by problem.addCheckTimeCallback.
Topic areas
Callback, Limits
Synopsis
`problem.addCheckTimeCallback(checktime, data=None, priority=0)`
`checktime(cbprob, cbdata)`
Arguments

checktime | The callback function, which takes arguments cbprob and cbdata, and has an integer return value. This function is called every time the Optimizer checks against the time limit.
data: Any | A user-defined data to be passed to the callback function, checktime.
priority: int | An integer that determines the order in which multiple checktime callbacks 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, checktime.
cbdata: Any | The user-defined data passed as data when setting up the callback.

Further information
1. If the callback function returns a nonzero value the solution process will be interrupted. If multiple callbacks of this type are registered, then all of them will be invoked and the solution process will be interrupted if any of them returned a nonzero value.
2. Querying problem data or changing controls is not possible within this callback.
Related topics
problem.removeCheckTimeCallback MAXTIME CHECKSONMAXTIME MAXCHECKSONMAXTIME
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.