Itasca C++ Interface
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
isettings.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include "base/src/baseqt.h"
4 
10 namespace itasca {
12 
15  class ISettings {
16  public:
18  virtual const QObject *getQObject() const=0;
19 
22  //virtual bool getCaseSensitivity() const=0;
23 
25  virtual bool getLog() const=0;
26 
28  virtual QString getLogFileName() const=0;
29 
32  virtual bool getSafeConversion() const=0;
33 
35  virtual bool getEcho() const=0;
36 
38  virtual QString getCustomerTitle1() const=0;
40  virtual QString getCustomerTitle2() const=0;
41 
43  virtual QString getJobTitle() const=0;
44 
46  virtual bool getLHS() const=0;
47 
49  // e.g.: (null) = Full or Non-Cycling license, "Demonstration" License, "Academic" License, etc.
50  virtual QString getLicense() const=0;
51 
53  virtual bool getAcademicModel() const=0;
54 
56  virtual bool getDemoModel() const=0;
57 
59  virtual uint getUpdateInterval() const=0;
60 
62  virtual bool getReadOnly() const=0;
63 
66  virtual bool getUnrepeatable() const=0;
67 
68  // True if the current model state was read from a results file.
69  // Cycling (and maybe other things) is disabled in this state.
70  virtual bool getResultsState() const=0;
71 
72  virtual bool getAutoModelSave() const=0;
73  virtual double getAutoModelSaveInterval() const=0;
74  virtual QString getAutoModelSaveDirectory() const=0;
75 
77  virtual void setUpdateInterval(uint u)=0;
79  virtual void setLog(bool b,QIODevice::OpenMode=QIODevice::Append)=0;
81  virtual void setLogFileName(const QString &s,QIODevice::OpenMode=QIODevice::Append)=0;
82 
83  virtual void setAutoModelSave(bool b)=0;
84  virtual void setAutoModelSaveInterval(double d)=0;
85  virtual void setAutoModelSaveDirectory(const QString &s)=0;
86 
87  // signals
89  //virtual void caseSensitivityChanged(bool b)=0;
91  virtual void logChanged(bool b)=0;
93  virtual void logFileNameChanged(const QString &name)=0;
95  virtual void safeConversionChanged(bool b)=0;
97  virtual void echoChanged(bool b)=0;
99  virtual void customerTitle1Changed(const QString &)=0;
101  virtual void customerTitle2Changed(const QString &)=0;
103  virtual void jobTitleChanged(const QString &)=0;
105  virtual void LHSChanged(bool b)=0;
107  virtual void licenseChanged(const QString &s)=0;
109  virtual void academicModelChanged(bool b)=0;
111  virtual void demoModelChanged(bool b)=0;
113  virtual void updateIntervalChanged(uint u)=0;
115  virtual void unrepeatableChanged(bool b)=0;
116 
117  virtual void autoModelSaveChanged(bool b)=0;
118  virtual void autoModelSaveIntervalChanged(double d)=0;
119  virtual void autoModelSaveDirectoryChanged(const QString &s)=0;
120  };
121 } // namespace itasca
122 // EoF
virtual void LHSChanged(bool b)=0
This signal is emitted when the Left Hand coordinate System state has changed. See getLHS().
virtual void licenseChanged(const QString &s)=0
This signal is emitted when the license has changed. See getLicense().
virtual bool getReadOnly() const =0
True if the model state has been tagged as read only.
virtual void setUpdateInterval(uint u)=0
Sets the frequency of notices during cycling.
virtual void echoChanged(bool b)=0
This signal is emitted when the echo state has changed. See getEcho().
namespace Itasca
Definition: basememory.cpp:9
virtual void demoModelChanged(bool b)=0
This signal is emitted when the demo model state has changed. See getDemoModel()
virtual QString getCustomerTitle2() const =0
Returns the customer title (2) set by the user and stored persistantly.
virtual void academicModelChanged(bool b)=0
This signal is emitted when the academic model state has changed. See getAcademicModel().
virtual bool getLHS() const =0
Returns TRUE if a Left Handed coordinate system is being used.
virtual const QObject * getQObject() const =0
Returns a pointer to a QObject representing this object.
virtual QString getLicense() const =0
Returns the current license terms. .
virtual bool getUnrepeatable() const =0
virtual bool getLog() const =0
Returns TRUE if text output is being sent to a log file as well.
virtual void unrepeatableChanged(bool b)=0
This signal is emitted when the unrepeatable state of the model has changed. See getUnrepeatable.
virtual void jobTitleChanged(const QString &)=0
This signal is emitted when the job title has changed. See getJobTitle().
virtual bool getEcho() const =0
Returns TRUE if command input is being printed out when received.
virtual void customerTitle1Changed(const QString &)=0
This signal is emitted when the customet title 1 has changed. See getCustomerTitle1().
virtual void customerTitle2Changed(const QString &)=0
This signal is emitted when the customet title 2 has changed. See getCustomerTitle2().
virtual void logChanged(bool b)=0
This signal is emitted when the case sensitivity state has changed. See getCaseSensitivity()
virtual bool getAcademicModel() const =0
True if any cycling was ever done under an academic license.
virtual void logFileNameChanged(const QString &name)=0
This signal is emitted when the log file name has changed. See getLogFileName()
virtual bool getDemoModel() const =0
True if any cycling was ever done under a demo license.
virtual QString getJobTitle() const =0
Returns the Job title associated with the current model.
virtual uint getUpdateInterval() const =0
Returns the frequency of notices during cycling.
virtual bool getSafeConversion() const =0
virtual void setLogFileName(const QString &s, QIODevice::OpenMode=QIODevice::Append)=0
Sets the current log file.
virtual void updateIntervalChanged(uint u)=0
This signal is emitted when the update interval has changed. See getUpdateInterval(),...
virtual void safeConversionChanged(bool b)=0
This signal is emitted when the safe conversion state has changed. See getSafeConversion().
All default base headers if Qt is being used.
Interface for accessing kernel settings.
Definition: isettings.h:15
virtual QString getLogFileName() const =0
Returns the name of the log file (whether logging is on or not).
virtual QString getCustomerTitle1() const =0
Returns the customer title (1) set by the user and stored persistantly.
virtual void setLog(bool b, QIODevice::OpenMode=QIODevice::Append)=0
Sets the log file on or off.