Initializing help system before first use

problem.addcbusersolnotify

problem.addcbusersolnotify

Purpose
Declares a callback function to be called each time a solution added by problem.addmipsol has been processed. This callback function will be called in addition to any callbacks already added by addcbusersolnotify.
Synopsis

problem.addcbusersolnotify(callback, data, priority)

callback(my_prob, my_object, solname, status)
Arguments
callback 
The callback function which takes four arguments, my_prob, my_object, id and status and has no return value.
my_prob 
The problem passed to the callback function, callback.
my_object 
The user-defined object passed as object when setting up the callback with addcbusersolnotify.
solname 
The string name assigned to the solution when it was loaded into the Optimizer using problem.addmipsol.
status 
One of the following status values:
0 
An error occured while processing the solution.
1 
Solution is feasible.
2 
Solution is feasible after reoptimizing with fixed globals.
3 
A local search heuristic was applied and a feasible solution discovered.
4 
A local search heuristic was applied but a feasible solution was not found.
5 
Solution is infeasible and a local search could not be applied.
6 
Solution is partial and a local search could not be applied.
7 
Failed to reoptimize the problem with globals fixed to the provided solution. Likely because a time or iteration limit was reached.
8 
Solution is dropped. This can happen if the MIP problem is changed or solved to completion before the solution could be processed.
data 
A user-defined object to be passed to the callback function, callback.
priority 
An integer that determines the order in which multiple 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.
Further information
If presolve is turned on, any solution added with problem.addmipsol will first be presolved before it can be checked. The value returned in status refers to the presolved solution, which might have had values adjusted due to bound changes, fixing of variables, etc.
Related topics
problem.removecbusersolnotify, problem.addmipsol.

Parent Topic Reference Manual