Itasca C++ Interface
|
Interface describing ALL output support the kernel needs to send information to whatever interface is driving it. More...
#include <ikerneloutput.h>
Public Types | |
enum | CycleOutputMode { InfoCycleOutputMode , HeaderCycleOutputMode , DataCycleOutputMode , Data2CycleOutputMode , CloseCycleOutputMode } |
Public Member Functions | |
virtual void | information (const QString &s)=0 |
Used to output helpful information messages. May throw a quit exception or interrupt exception. | |
virtual void | warning (const QString &s, uint level, int line, const QString &file)=0 |
virtual void | error (const QString &s, int line, const QString &file, bool expected)=0 |
Used to output error messages - called from Kernel after catching exception. May throw a quit exception or interrupt exception. | |
virtual void | progress (int per, const QString &message)=0 |
virtual void | waitNotice (bool show, const QString &message)=0 |
Displays wait message. If show is false, message is cleared from output device. Function does not block, but it may throw quit exception. | |
virtual void | interfaceGuiCommand (const itasca::IParse &par)=0 |
Parses a GUI command. May throw any exception. Not supported in console interface. | |
virtual void | interfacePlotCommand (const itasca::IParse &par)=0 |
Parses a PLOT command. May throw any exception. Not supported in console interface. | |
virtual ITextOutput * | getITextOutput ()=0 |
Returns a pointer to ITextOutput. | |
virtual void | informationOn (bool b)=0 |
Indicates that output 'information' mode is on. | |
virtual bool | informationOn () const =0 |
virtual void | warningOn (bool b)=0 |
Indicates that output 'warning' mode is on. | |
virtual bool | warningOn () const =0 |
virtual void | globalPaginationOn (bool b)=0 |
Sets output global pagination ON/OFF. | |
virtual void | cyclingOutput (uint32 mode, const StringList &list)=0 |
virtual void | logEvent (const string &str)=0 |
virtual void | displayHelpFile (const string &file, const string &pagePath, uint32 command=0, const string &windowName="Mainwin")=0 |
Display the contents of a help file. | |
Interface describing ALL output support the kernel needs to send information to whatever interface is driving it.
Centralized pipe for all output the kernel needs from outside the kernel process itself. ingroup utility
Enumeration specifying the meaning of the cyclingOutput method. In terms of the GUI cycling indicator: Info is the line (or lines) of text above the header, with general information, also indicates start. Header are the headers for each column of text updated during cycling. Data is the first values in each column (current values). Data2 is the second values in each column (limits). Close indicates cycling ended.
|
pure virtual |
Output information during cycling, according to the CycleOutputMode. Any exception. The modes are defined in CycleOutputMode above.
|
pure virtual |
Progress indicator. Initiate with a negative percentage and a valid message.
Update with a percentage between 0 and 100 inclusive (message not used).
Finish with a per over 100 (message not used).
May throw a quit exception or interrupt exception.
|
pure virtual |
Used to output warning messages, something might be wrong but it isn't an error that should stop processing. May throw a quit exception or interrupt exception.