problem.addcbmessage
problem.addcbmessage |
Purpose
Declares an output callback function, called every time a text line relating to the given prob is output by the Optimizer. This callback function will be called in addition to any callbacks already added by addcbmessage.
Synopsis
problem.addcbmessage(callback, data, priority)
callback(my_prob, my_object, msg, msgtype)
Arguments
|
callback
|
The callback function which takes five arguments,
my_prob,
my_object,
msg,
len and
msgtype, and has no return value. Use a
None value to cancel a callback function.
|
||||||||
|
my_prob
|
The problem passed to the callback function.
|
||||||||
|
my_object
|
The user-defined object passed as
object when setting up the callback with
addcbmessage.
|
||||||||
|
msg
|
A null terminated character array (string) containing the message, which may simply be a new line.
|
||||||||
|
msgtype
|
Indicates the type of output message:
A negative value indicates that the Optimizer is about to finish and the buffers should be flushed at this time if the output is being redirected to a file.
|
||||||||
|
data
|
A user-defined object to be passed to the callback function.
|
||||||||
|
priority
|
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.
|
Example
The following example simply sends all output to the screen (
stdout):
prob.addcbmessage(Message, None, 0)
The callback function might resemble:
def Message(my_prob, object, msg, msgtype):
print('{0}: {1}'.format(msgtype, msg))
Further information
1. Screen output is automatically created by the Optimizer Console only. To produce output when using the Optimizer library, it is necessary to define this callback function and use it to print the messages to the screen (
stdout).
2. This function offers one method of handling the messages which describe any warnings and errors that may occur during execution. Other methods are to check the return values of functions and then get the error code using the
errorcode attribute, obtain the last error message directly using
problem.getlasterror, or send messages direct to a log file using
problem.setlogfile.
Related topics
problem.removecbmessage,
problem.addcbbarlog,
problem.addcbgloballog,
problem.addcblplog,
problem.setlogfile.