Itasca C++ Interface
Loading...
Searching...
No Matches
ikerneloutput.h
1#pragma once
2
3#include "base/src/base.h"
4
5namespace itasca {
6 class ITextOutput;
7 class IParse;
8
15 public:
30 virtual void information(const string &s)=0;
33 virtual void warning(const string &s,uint32 level,int line,const string &file)=0;
35 virtual void error(const string &s,int line,const string &file,bool expected)=0;
40 virtual void progress(int per,const string &message)=0;
42 virtual void waitNotice(bool show,const string &message)=0;
44 virtual void interfaceGuiCommand(const itasca::IParse &par)=0;
46 virtual void interfacePlotCommand(const itasca::IParse &par)=0;
50 virtual void informationOn(bool b)=0;
51 virtual bool informationOn() const=0;
53 virtual void warningOn(bool b)=0;
54 virtual bool warningOn() const=0;
56 virtual void globalPaginationOn(bool b)=0;
59 virtual void cyclingOutput(uint32 mode,const StringList &list)=0;
60 virtual void logEvent(const string &str)=0;
62 virtual void setActive(bool) {}
64 virtual void displayHelpFile(const string &file, const string &pagePath,uint32 command=0, const string &windowName = "Mainwin")=0;
66 //virtual void addAlternateDataFilePrefix(const string &pref)=0;
67
68 //virtual bool acceptRedirect() const=0;
69 //virtual void setRedirectOutput(IKernelOutput * ko)=0;
70 };
71} // /namespace itasca
72// EOF
One stop include for all objects defined as part of base interface.
Definition basestring.h:71
Definition expected.h:25
Interface describing ALL output support the kernel needs to send information to whatever interface is...
Definition ikerneloutput.h:14
virtual void warningOn(bool b)=0
Indicates that output 'warning' mode is on.
virtual void interfacePlotCommand(const itasca::IParse &par)=0
Parses a PLOT command. May throw any exception. Not supported in console interface.
virtual void progress(int per, const string &message)=0
virtual void warning(const string &s, uint32 level, int line, const string &file)=0
virtual void cyclingOutput(uint32 mode, const StringList &list)=0
virtual void interfaceGuiCommand(const itasca::IParse &par)=0
Parses a GUI command. May throw any exception. Not supported in console interface.
virtual void globalPaginationOn(bool b)=0
Sets output global pagination ON/OFF.
virtual void informationOn(bool b)=0
Indicates that output 'information' mode is on.
virtual void setActive(bool)
Used to prevent output in MPI processes in which the rank is not zero.
Definition ikerneloutput.h:62
virtual ITextOutput * getITextOutput()=0
Returns a pointer to ITextOutput.
virtual void displayHelpFile(const string &file, const string &pagePath, uint32 command=0, const string &windowName="Mainwin")=0
Display the contents of a help file.
CycleOutputMode
Definition ikerneloutput.h:23
@ InfoCycleOutputMode
Info strings passed, cycling started.
Definition ikerneloutput.h:23
@ DataCycleOutputMode
Data strings passed, cycling ongoing.
Definition ikerneloutput.h:25
@ HeaderCycleOutputMode
Header strings passed, cycling ongoing.
Definition ikerneloutput.h:24
@ Data2CycleOutputMode
Second row of data strings passed.
Definition ikerneloutput.h:26
@ CloseCycleOutputMode
Cycling stopped, strings ignored.
Definition ikerneloutput.h:27
virtual void waitNotice(bool show, const string &message)=0
Displays wait message. If show is false, message is cleared from output device. Function does not blo...
virtual void error(const string &s, int line, const string &file, bool expected)=0
Used to output error messages - called from Kernel after catching exception. May throw a quit excepti...
virtual void information(const string &s)=0
Used to output helpful information messages. May throw a quit exception or interrupt exception.
Interface to the main command processing class.
Definition iparse.h:49
Provides a interface for simple writing of text.
Definition itextoutput.h:13
namespace Itasca
Definition basememory.cpp:14