an interface defining the kernel call back functions - Maple Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Programming : OpenMaple : Java Application Programming Interface : EngineCallBacks Interface : OpenMaple/Java/EngineCallBacks

EngineCallBacks - an interface defining the kernel call back functions

Description

• 

The com.maplesoft.openmaple.EngineCallBacks interface is used for implementing the call back object required to create a Engine object.  A default implementation of this interface, EngineCallBacksDefault is provided.

Member Summary

static const int MAPLE_TEXT_OUTPUT

• 

This constant is passed to the textCallBack function to indicate that the text is output generated from the evaluation of a Maple statement.

static const int MAPLE_TEXT_DIAG

• 

This constant is passed to the textCallBack function to indicate that the text is diagnostic output, for example high printlevel or trace output.

static const int MAPLE_TEXT_MISC

• 

This constant is passed to the textCallBack function to indicate that the text is from a miscellaneous source, for example the Maple printf function.

static const int MAPLE_TEXT_HELP

• 

This constant is passed to the textCallBack function to indicate that the text is the output of a help request.  For a more comprehensive help facility, see getHelp.

static const int MAPLE_TEXT_QUIT

• 

This constant is passed to the textCallBack function to indicate that the text is output generated in response to a quit, done or stop command.

static const int MAPLE_TEXT_WARNING

• 

This constant is passed to the textCallBack function to indicate that the text is output from a warning generated during a computation.

static const int MAPLE_TEXT_ERROR

• 

This constant is passed to the textCallBack function to indicate that the text is output from an error raised during parsing or evaluating.  This will occur only if the errorCallBack function redirects the error message into the textCallBack function.

static const int MAPLE_TEXT_STATUS

• 

This constant is passed to the textCallBack function to indicate that the text is output generated from a kernel status message, (the "bytes used" message").   This will occur only if the statusCallBack function redirects the status messages into the textCallBack function. This is the default behavior when using the EngineCallBacksDefault class.

static const int MAPLE_TEXT_DEBUG

• 

This constant is passed to the textCallBack function to indicate that the text is output generated from the Maple debugger.

Method Summary

void textCallBack( Object data, int tag, String output ) throws MapleException

• 

The textCallBack function is called when a text message generated by the kernel should be displayed.

void errorCallBack( Object data, int offset, String msg ) throws MapleException

• 

The errorCallBack function is called when an error should be raised to the user.

void statusCallBack( Object data, long bytesUsed, long bytesAlloc, double cputime ) throws MapleException

• 

The statusCallBack function called to report the resource usage (the "bytes used" messages).

String readlineCallBack( Object data, boolean debug ) throws MapleException

• 

The readlineCallBack function is called when Maple requires input from the user.

boolean redirectCallBack( Object data, String name, boolean append ) throws MapleException

• 

The redirectCallBack function is called when Maple executes a writeto or appendto.

String callBackCallBack( Object data, String args ) throws MapleException

• 

The callBackCallBack function is called when the function callback is executed in Maple.

boolean queryInterrupt( Object data ) throws MapleException

• 

The queryInterrupt function is called periodically to see if Maple should interrupt.

String streamCallBack( Object data, String name, String args[] ) throws MapleException

• 

The streamCallBack function handles Stream calls.

See Also

OpenMaple, OpenMaple/Java/Engine OpenMaple/Java/Engine/Engine, OpenMaple/Java/EngineCallBacks/callBackCallBack OpenMaple/Java/EngineCallBacks/queryInterrupt, OpenMaple/Java/EngineCallBacks/errorCallBack OpenMaple/Java/EngineCallBacks/statusCallBack, OpenMaple/Java/EngineCallBacks/readlineCallBack OpenMaple/Java/EngineCallBacks/redirectCallBack, OpenMaple/Java/EngineCallBacks/streamCallBack OpenMaple/Java/EngineCallBacksDefault, OpenMaple/Java/EngineCallBacks/textCallBack


Download Help Document

Was this information helpful?



Please add your Comment (Optional)
E-mail Address (Optional)
What is ? This question helps us to combat spam