Frobby  0.9.5
CommonParams.h
Go to the documentation of this file.
1 /* Frobby: Software for monomial ideal computations.
2  Copyright (C) 2009 University of Aarhus
3  Contact Bjarke Hammersholt Roune for license information (www.broune.com)
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9 
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU General Public License for more details.
14 
15  You should have received a copy of the GNU General Public License
16  along with this program. If not, see http://www.gnu.org/licenses/.
17 */
18 #ifndef COMMON_PARAMS_GUARD
19 #define COMMON_PARAMS_GUARD
20 
21 #include <string>
22 
23 class CliParams;
24 
25 class CommonParams {
26  public:
27  CommonParams();
28 
38  bool getIdealIsMinimal() const {return _idealIsMinimal;}
39  void idealIsMinimal(bool value) {_idealIsMinimal = value;}
40 
43  bool getPrintActions() const {return _printActions;}
44  void printActions(bool value) {_printActions = value;}
45 
47  const string& getInputFormat() const {return _inputFormat;}
48  void setInputFormat(const string& value) {_inputFormat = value;}
49 
51  const string& getOutputFormat() const {return _outputFormat;}
52  void setOutputFormat(const string& value) {_outputFormat = value;}
53 
57  void produceCanonicalOutput(bool value) {_produceCanonicalOutput = value;}
58 
61  bool getPrintDebug() const {return _printDebug;}
62  void printDebug(bool value) {_printDebug = value;}
63 
66  bool getPrintStatistics() const {return _printStatistics;}
67  void printStatistics(bool value) {_printStatistics = value;}
68 
69  private:
75 
76  string _inputFormat;
77  string _outputFormat;
78 };
79 
80 void addCommonParams(CliParams& params);
81 void addDebugParam(CliParams& params);
82 
83 void extractCliValues(CommonParams& common, const CliParams& cli);
84 
85 #endif
void extractCliValues(CommonParams &common, const CliParams &cli)
void addDebugParam(CliParams &params)
void addCommonParams(CliParams &params)
const string & getOutputFormat() const
Returns the format in which output is produced.
Definition: CommonParams.h:51
void printStatistics(bool value)
Definition: CommonParams.h:67
void printActions(bool value)
Definition: CommonParams.h:44
void idealIsMinimal(bool value)
Definition: CommonParams.h:39
bool _printStatistics
Definition: CommonParams.h:74
void setOutputFormat(const string &value)
Definition: CommonParams.h:52
string _outputFormat
Definition: CommonParams.h:77
bool getPrintStatistics() const
Returns whether to print statistics on what the algorithm did to standard error after it has run.
Definition: CommonParams.h:66
bool _idealIsMinimal
Definition: CommonParams.h:70
const string & getInputFormat() const
Returns the format used for parsing input.
Definition: CommonParams.h:47
void printDebug(bool value)
Definition: CommonParams.h:62
bool getPrintDebug() const
Returns whether to print information about what the algorithm is doing to standard error as it runs.
Definition: CommonParams.h:61
bool _produceCanonicalOutput
Definition: CommonParams.h:72
string _inputFormat
Definition: CommonParams.h:76
void produceCanonicalOutput(bool value)
Definition: CommonParams.h:57
void setInputFormat(const string &value)
Definition: CommonParams.h:48
bool getPrintActions() const
Returns whether to print and time the large-scale actions that Frobby performs.
Definition: CommonParams.h:43
bool _printActions
Definition: CommonParams.h:71
bool getIdealIsMinimal() const
Returns whether the input ideal is known to be minimally generated.
Definition: CommonParams.h:38
bool _printDebug
Definition: CommonParams.h:73
bool getProduceCanonicalOutput() const
Returns whether to produce output in a canonical representation.
Definition: CommonParams.h:56