FEDEM Solver  R8.0
Source code of the dynamics solver
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
F90Msg Class Reference

A sub-class of FFaMsg that passes the list-messages to Fortran. More...

Inheritance diagram for F90Msg:
Inheritance graph
[legend]
Collaboration diagram for F90Msg:
Collaboration graph
[legend]

Public Member Functions

 F90Msg (int whichFile=0)
 Default constructor. More...
 
virtual ~F90Msg ()
 Empty destructor. More...
 
- Public Member Functions inherited from FFaMsg
 FFaMsg ()
 Default constructor. More...
 
virtual ~FFaMsg ()
 Empty destructor. More...
 
virtual bool openListFile (const char *=NULL, bool=false)
 Opens a list file containing a copy of the output list window. More...
 
virtual void closeListFile ()
 Closes the list file. More...
 

Protected Member Functions

virtual void listVt (const std::string &message, bool)
 Writes the message to the Fortran file, line by line. More...
 
- Protected Member Functions inherited from FFaMsg
virtual int dialogVt (const std::string &message, const FFaDialogType type, const char **genericButtons)
 Shows a dialog according to the dialog type. More...
 
virtual int dialogVt (const std::string &message, const FFaDialogType type, const std::vector< std::string > &buttonTexts)
 Shows a dialog according to the dialog type. More...
 
virtual int dialogVt (int &returnedSelectionIdx, const std::string &message, const FFaDialogType type, const std::vector< std::string > &buttonTexts, const std::vector< std::string > &selectionList)
 Overloaded method with additional selection from a list. More...
 
virtual void tipVt (const std::string &str)
 Prints tip message to the console. More...
 
virtual void setStatusVt (const std::string &)
 GUI interface for setting the status message. More...
 
virtual void changeStatusVt (const std::string &)
 GUI interface for changing the status message. More...
 
virtual void pushStatusVt (const std::string &)
 GUI interface for pushing a new status message. More...
 
virtual void popStatusVt ()
 GUI interface for popping the status message stack. More...
 
virtual void enableSubStepsVt (int)
 GUI interface for enabling substep counting. More...
 
virtual void setSubStepVt (int)
 GUI interface for assigning the substep counter. More...
 
virtual void disableSubStepsVt ()
 GUI interface for clearing the substep counter. More...
 
virtual void displayTimeVt (int, int, int)
 GUI interface for displaying the elapsed time of a solver process. More...
 
virtual void clearTimeVt ()
 GUI interface for clearing the elapsed time display. More...
 
virtual void setSubTaskVt (const std::string &)
 GUI interface for setting the subtask message. More...
 
virtual void enableProgressVt (int)
 GUI interface for enabling the progress bar. More...
 
virtual void setProgressVt (int)
 GUI interface for updating the progress counter. More...
 
virtual void disableProgressVt ()
 GUI interface for clearing the progress counter. More...
 

Private Attributes

int ifile
 File option (0: write to error log file, 1: write to res-file) More...
 

Additional Inherited Members

- Public Types inherited from FFaMsg
enum  FFaDialogType {
  DISMISS_WARNING , DISMISS_ERROR , DISMISS_INFO , WARNING ,
  ERROR , OK , OK_CANCEL , YES_NO ,
  YES_NO_CANCEL , _ALL_ , OK_ALL_CANCEL , YES_ALL_NO ,
  YES_ALL_NO_ALL , YES_ALL_NO_CANCEL , YES_ALL_NO_ALL_CANCEL , YES_NO_ALL ,
  YES_NO_ALL_CANCEL , GENERIC
}
 Enums defining various dialog box types. More...
 
- Static Public Member Functions inherited from FFaMsg
static void setMessager (FFaMsg *messager=NULL)
 Sets the real messager object to be used. More...
 
static FFaMsg & getMessager ()
 Returns the current messager object. More...
 
static bool usingDefault ()
 Returns true if we are using the default messager. More...
 
static void resetToAllAnswer (const FFaDialogType type=_ALL_)
 Clears the multiple query answer given dialog type or all. More...
 
static int dialog (const std::string &message, const FFaDialogType type=DISMISS_WARNING, const char **genericButtons=(const char **) NULL)
 Shows a dialog according to the dialog type. More...
 
static int dialog (int &returnedSelectionIdx, const std::string &message, const FFaDialogType type, const std::vector< std::string > &buttonTexts, const std::vector< std::string > &selectionList)
 Overloaded method with additional selection from a list. More...
 
static void list (const std::string &str, bool onScreen=false)
 Prints a message to the Output List GUI (or console). More...
 
static void tip (const std::string &str)
 Updates the tip message in the GUI (or prints it to console). More...
 
static void setStatus (const std::string &statusText)
 Sets the status message, but only the the status stack is empty. More...
 
static void changeStatus (const std::string &statusText)
 Replaces the top message of the status stack. More...
 
static void pushStatus (const std::string &statusText)
 Pushes a new message to the status stack. More...
 
static void popStatus ()
 Pops the status stack such that the previous message appears. More...
 
static void enableSubSteps (int steps)
 Enables substep counting in the GUI, in the range 1 to steps. More...
 
static void setSubStep (int step)
 Assigns the substep counter. More...
 
static void disableSubSteps ()
 Clears the substep counter. More...
 
static void displayTime (int hour, int min, int sec)
 Displays the elapsed time of a solver process in the GUI. More...
 
static void clearTime ()
 Clears the elapsed time display. More...
 
static void setSubTask (const std::string &taskText)
 Sets the subtask message in the GUI. More...
 
static void enableProgress (int nSteps)
 Enables a progress bar in the GUI, in range 1 to nSteps. More...
 
static void setProgress (int progressStep)
 Updates the progress counter. More...
 
static void disableProgress ()
 Clears the progress counter. More...
 

Detailed Description

A sub-class of FFaMsg that passes the list-messages to Fortran.

All other member functions are empty (does nothing).

Constructor & Destructor Documentation

◆ F90Msg()

F90Msg::F90Msg ( int  whichFile = 0)
inline

Default constructor.

◆ ~F90Msg()

virtual F90Msg::~F90Msg ( )
inlinevirtual

Empty destructor.

Member Function Documentation

◆ listVt()

virtual void F90Msg::listVt ( const std::string &  message,
bool   
)
inlineprotectedvirtual

Writes the message to the Fortran file, line by line.

Reimplemented from FFaMsg.

Member Data Documentation

◆ ifile

int F90Msg::ifile
private

File option (0: write to error log file, 1: write to res-file)


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