CUserInput Class Reference
class providing user input information to other classes More...
#include <CUserInput.hpp>
Public Member Functions | |
| CUserInput () | |
| constructor | |
| virtual | ~CUserInput () |
| -virtual- destructor | |
| virtual int | mainAnalyzeRoutine () |
| virtual double | galaxyAge () |
| virtual double | baseval () |
Detailed Description
class providing user input information to other classesThis class is an interface between the computing backbone(s) of the program and the user. User input should pass through an instance of this class, or a class derived from this class which overrides suitable methods. This way it is possible to e.g. have an instance of this class asking the user for data through the command line, whilst a different instance might get that data from the choices the user makes on a gui.
This implies that programs should _never_ try to contact the user directly, all communication must proceed through this interface.
Note: because sip does not seem to handle pure virtual very well we are providing default implementations. This does not mean that you should not reimplement the functions that have an empty body! If this documentation is up to date it should be mentioned for each function if it must be overridden.
Member Function Documentation
| double CUserInput::baseval | ( | void | ) | [virtual] |
Get baseval: multiples of this value are used as delimiting radii when finding the gas (sph) mass inside these radii for the 9th summary file. Default: 1.5
| double CUserInput::galaxyAge | ( | void | ) | [virtual] |
Get the offset applied to the galaxy age (default: -1.)
| int CUserInput::mainAnalyzeRoutine | ( | ) | [virtual] |
Return an integer to choose the category of programs for analysis:
- : calculate all
- : plotting routines
- : analysis routines
- : redundant routines
The documentation for this class was generated from the following files:
