bpp-core  2.2.0
BppApplication.cpp
Go to the documentation of this file.
1 //
2 // File: BppApplication.cpp
3 // Created by: Julien Dutheil
4 // Created on: Sat Aug 08 08:21 2009
5 //
6 
7 /*
8 Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)
9 
10 This software is a computer program whose purpose is to provide basal and
11 utilitary classes. This file belongs to the Bio++ Project.
12 
13 This software is governed by the CeCILL license under French law and
14 abiding by the rules of distribution of free software. You can use,
15 modify and/ or redistribute the software under the terms of the CeCILL
16 license as circulated by CEA, CNRS and INRIA at the following URL
17 "http://www.cecill.info".
18 
19 As a counterpart to the access to the source code and rights to copy,
20 modify and redistribute granted by the license, users are provided only
21 with a limited warranty and the software's author, the holder of the
22 economic rights, and the successive licensors have only limited
23 liability.
24 
25 In this respect, the user's attention is drawn to the risks associated
26 with loading, using, modifying and/or developing or reproducing the
27 software by the user in light of its specific status of free software,
28 that may mean that it is complicated to manipulate, and that also
29 therefore means that it is reserved for developers and experienced
30 professionals having in-depth computer knowledge. Users are therefore
31 encouraged to load and test the software's suitability as regards their
32 requirements in conditions enabling the security of their systems and/or
33 data to be ensured and, more generally, to use and operate it in the
34 same conditions as regards security.
35 
36 The fact that you are presently reading this means that you have had
37 knowledge of the CeCILL license and that you accept its terms.
38 */
39 
40 #include "BppApplication.h"
41 #include "../Utils/AttributesTools.h"
42 #include "../Numeric/Random/RandomTools.h"
43 #include "ApplicationTools.h"
44 
45 // From the STL:
46 #include <iostream>
47 
48 using namespace bpp;
49 using namespace std;
50 
51 BppApplication::BppApplication(int argc, char* argv[], const std::string& name): appName_(name), params_(), timerStarted_(false)
52 {
53  cout << "Parsing options:" << endl;
56  bool noint = ApplicationTools::getBooleanParameter("--noninteractive", params_, false, "", true, 3);
58  long seed = ApplicationTools::getParameter<long>("--seed", params_, -1, "", true, 3);
59  if (seed >= 0) {
61  ApplicationTools::displayResult("Random seed set to", seed);
62  }
63 }
64 
66 {
68  timerStarted_ = true;
69 }
70 
72 {
73  cout << appName_ << "'s done. Bye." << endl;
74  if (timerStarted_)
75  ApplicationTools::displayTime("Total execution time:");
76 }
77 
static int getIntParameter(const std::string &parameterName, std::map< std::string, std::string > &params, int defaultValue, const std::string &suffix="", bool suffixIsOptional=true, int warn=0)
Get an integer parameter.
std::string appName_
This class allows to perform a correspondence analysis.
static int warningLevel
Specify the amount of warning to display.
static void displayTime(const std::string &msg)
Display the current timer value to the &#39;message&#39; stream.
static std::map< std::string, std::string > parseOptions(int args, char **argv)
Global function that reads all parameters from command line and files, and set the values in a map...
static void displayResult(const std::string &text, const T &result)
Print a result message.
STL namespace.
static bool getBooleanParameter(const std::string &parameterName, std::map< std::string, std::string > &params, bool defaultValue, const std::string &suffix="", bool suffixIsOptional=true, int warn=0)
Get a boolean parameter.
static void startTimer()
Starts the timer.
std::map< std::string, std::string > params_
BppApplication(int argc, char *argv[], const std::string &name)
static void setSeed(long seed)
Set the default generator seed.
Definition: RandomTools.cpp:55
static bool interactive
Tell if the program is interactive (typically run in foreground). Default to yes. ...