Itasca C++ Interface
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
itasca::ISettings Class Referenceabstract

Interface for accessing kernel settings. More...

#include <isettings.h>

Public Types

using OpenAction = shared::IFile::OpenAction
 

Public Member Functions

virtual bool getLog () const =0
 Returns TRUE if text output is being sent to a log file as well.
 
virtual string getLogFileName () const =0
 Returns the name of the log file (whether logging is on or not).
 
virtual bool getSafeConversion () const =0
 
virtual bool getEcho () const =0
 Returns TRUE if command input is being printed out when received.
 
virtual string getCustomerTitle1 () const =0
 Returns the customer title (1) set by the user and stored persistantly.
 
virtual string getCustomerTitle2 () const =0
 Returns the customer title (2) set by the user and stored persistantly.
 
virtual string getJobTitle () const =0
 Returns the Job title associated with the current model.
 
virtual bool getLHS () const =0
 Returns TRUE if a Left Handed coordinate system is being used.
 
virtual string getLicense () const =0
 Returns the current license terms.
.
 
virtual bool getAcademicModel () const =0
 True if any cycling was ever done under an academic license.
 
virtual bool getDemoModel () const =0
 True if any cycling was ever done under a demo license.
 
virtual uint32 getUpdateInterval () const =0
 Returns the frequency of notices during cycling.
 
virtual bool getReadOnly () const =0
 True if the model state has been tagged as read only.
 
virtual bool getUnrepeatable () const =0
 
virtual bool getResultsState () const =0
 
virtual bool getAutoModelSave () const =0
 
virtual double getAutoModelSaveInterval () const =0
 
virtual string getAutoModelSaveDirectory () const =0
 
virtual void setLog (bool b, OpenAction action=OpenAction::Append)=0
 
virtual void setLogFileName (const string &s, OpenAction action=OpenAction::Append)=0
 
virtual void setUpdateInterval (uint32 u)=0
 Sets the frequency of notices during cycling.
 
virtual void setAutoModelSave (bool b)=0
 
virtual void setAutoModelSaveInterval (double d)=0
 
virtual void setAutoModelSaveDirectory (const string &s)=0
 

Public Attributes

shared::Signal< bool > caseSensitivityChanged
 
shared::Signal< bool > logChanged
 
shared::Signal< const string & > logFileNameChanged
 
shared::Signal< bool > safeConversionChanged
 
shared::Signal< bool > echoChanged
 
shared::Signal< const string & > customerTitle1Changed
 
shared::Signal< const string & > customerTitle2Changed
 
shared::Signal< const string & > jobTitleChanged
 
shared::Signal< bool > LHSChanged
 
shared::Signal< const string & > licenseChanged
 
shared::Signal< bool > academicModelChanged
 
shared::Signal< bool > demoModelChanged
 
shared::Signal< uint32 > updateIntervalChanged
 
shared::Signal< bool > unrepeatableChanged
 
shared::Signal< bool > readOnlyChanged
 
shared::Signal< bool > resultsStateChanged
 
shared::Signal< bool > autoModelSaveChanged
 
shared::Signal< double > autoModelSaveIntervalChanged
 
shared::Signal< const string & > autoModelSaveDirectoryChanged
 

Detailed Description

Interface for accessing kernel settings.

These are global values that affect the program.

Member Function Documentation

◆ getCustomerTitle1()

virtual string itasca::ISettings::getCustomerTitle1 ( ) const
pure virtual

Returns the customer title (1) set by the user and stored persistantly.

See also
getCustomerTitle2()

◆ getCustomerTitle2()

virtual string itasca::ISettings::getCustomerTitle2 ( ) const
pure virtual

Returns the customer title (2) set by the user and stored persistantly.

See also
getCustomerTitle1()

◆ getSafeConversion()

virtual bool itasca::ISettings::getSafeConversion ( ) const
pure virtual

Returns TRUE if macros and fish symbols require a prefix character to be interpreted by the command processor. Default is true.

◆ getUnrepeatable()

virtual bool itasca::ISettings::getUnrepeatable ( ) const
pure virtual

True if the model state has been tagged as being unrepeatable, indicating that rerunning the model from an input record will not duplicate the model state.


The documentation for this class was generated from the following file: