multovl  1.3
Multiple overlaps of genomic regions
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
classicopts.hh
1 /* <LICENSE>
2 License for the MULTOVL multiple genomic overlap tools
3 
4 Copyright (c) 2007-2012, Dr Andras Aszodi,
5 Campus Science Support Facilities GmbH (CSF),
6 Dr-Bohr-Gasse 3, A-1030 Vienna, Austria, Europe.
7 All rights reserved.
8 
9 Redistribution and use in source and binary forms, with or without
10 modification, are permitted provided that the following conditions are
11 met:
12 
13  * Redistributions of source code must retain the above copyright notice,
14  this list of conditions and the following disclaimer.
15  * Redistributions in binary form must reproduce the above copyright notice,
16  this list of conditions and the following disclaimer in the documentation
17  and/or other materials provided with the distribution.
18  * Neither the name of the Campus Science Support Facilities GmbH
19  nor the names of its contributors may be used to endorse
20  or promote products derived from this software without specific prior
21  written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS
24 AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
25 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
26 AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
27 THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
29 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
30 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
31 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 </LICENSE> */
35 #ifndef CLASSICOPTS_HEADER
36 #define CLASSICOPTS_HEADER
37 
38 // == HEADER classicopts.hh ==
39 
47 // -- Base class header --
48 
49 #include "multovlopts.hh"
50 
51 // == Classes ==
52 
53 namespace multovl {
54 
57 {
58  public:
59 
60  ClassicOpts();
61 
63  const std::string& source() const { return _source; }
64 
66  const std::string& outformat() const { return _outformat; }
67 
70  const std::string& save_to() const { return _saveto; }
71 
77  const std::string& load_from() const { return _loadfrom; }
78 
80  std::vector<std::string> input_files() const { return pos_opts(); }
81 
82  virtual
83  std::string param_str() const;
84 
85  virtual
86  std::ostream& print_help(std::ostream& out) const;
87 
88  protected:
89 
90  virtual
91  bool check_variables();
92 
93  private:
94 
95  std::string _source, _outformat,
96  _saveto, _loadfrom;
97 };
98 
99 } // namespace multovl
100 
101 #endif // CLASSICOPTS_HEADER
102 
virtual bool check_variables()
Base class for option handling in the multovl family of tools.
Definition: multovlopts.hh:56
std::vector< std::string > input_files() const
Definition: classicopts.hh:80
const std::string & source() const
Definition: classicopts.hh:63
const std::string & outformat() const
Definition: classicopts.hh:66
const std::string & load_from() const
Definition: classicopts.hh:77
std::vector< std::string > pos_opts() const
const std::string & save_to() const
Definition: classicopts.hh:70
virtual std::ostream & print_help(std::ostream &out) const
Option handling for the file-based multovl tools.
Definition: classicopts.hh:56