This class provides FISH with input data.
More...
#include <iinput.h>
|
virtual void | debug (IDebug *fishdebug, const string &message)=0 |
|
virtual void | poll ()=0 |
| Checks if the system supports FISH intrinsic plugins. Non-null string indicates error message.
|
|
virtual itasca::IGUIInput * | getIGUIInput ()=0 |
| Returns interface to graphics user interface input functionality. May return a null value.
|
|
virtual bool | isTestMode ()=0 |
| Returns TRUE if command processing is in TEST mode.
|
|
virtual string | getInput (const string &prompt, bool interactive)=0 |
|
This class provides FISH with input data.
◆ debug()
virtual void fish::IInput::debug |
( |
IDebug * | fishdebug, |
|
|
const string & | message ) |
|
pure virtual |
Stops FISH processing and waits, providing an IFishDebug interface to give the function implementation a chance to debug the FISH code. This interface can be used to query variables, step through the function, etc. This function is intended to be the main interface to a FISH debugger implemented by the program controlling FISH.
- Parameters
-
fishdebug | A pointer to the IFishDebug interface that will be used to control the debug session. |
message | A message indicating why FISH processing was stopped and control passed to the debugger. |
◆ getInput()
virtual string fish::IInput::getInput |
( |
const string & | prompt, |
|
|
bool | interactive ) |
|
pure virtual |
Returns a single line of input from the current source. Will automatically pop the stack and use the next source if the current one runs out.
- Parameters
-
prompt | The prompt to use on the command line if appropriate. |
interactive | TRUE if the FISH input source is considered "interactive", i.e. the next line from a data file is not appropriate. |
◆ poll()
virtual void fish::IInput::poll |
( |
| ) |
|
|
pure virtual |
Checks if the system supports FISH intrinsic plugins. Non-null string indicates error message.
Allows GUI to interrupt if necessary, will throw InterruptException(false) if indicated by the system. Quit command will throw an exception.
The documentation for this class was generated from the following file:
- C:/Source/itasca-suite/common/fish/interface/iinput.h