bpp-seq  2.2.0
IoSequenceFactory.h
Go to the documentation of this file.
1 //
2 // File IoSequenceFactory.h
3 // Created by: Julien Dutheil
4 // Created on: Tue 18/04/06 10:24
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 classes
11 for sequences analysis.
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 #ifndef _IOSEQUENCEFACTORY_H_
41 #define _IOSEQUENCEFACTORY_H_
42 
43 #include "ISequence.h"
44 #include "OSequence.h"
45 #include "../Alphabet/Alphabet.h"
46 
47 namespace bpp
48 {
49 
54 {
55  public:
56  static const std::string FASTA_FORMAT;
57  static const std::string MASE_FORMAT;
58  static const std::string CLUSTAL_FORMAT;
59  static const std::string DCSE_FORMAT;
60  static const std::string PHYLIP_FORMAT_INTERLEAVED;
61  static const std::string PHYLIP_FORMAT_SEQUENTIAL;
62  static const std::string PAML_FORMAT_INTERLEAVED;
63  static const std::string PAML_FORMAT_SEQUENTIAL;
64  static const std::string GENBANK_FORMAT;
65  static const std::string NEXUS_FORMAT;
66 
67  public:
68 
81  virtual ~IoSequenceFactory() {}
82 
90  virtual ISequence* createReader(const std::string& format) throw (Exception);
91 
99  virtual IAlignment* createAlignmentReader(const std::string& format) throw (Exception);
100 
108  virtual OSequence* createWriter(const std::string& format) throw (Exception);
109 
117  virtual OAlignment* createAlignmentWriter(const std::string& format) throw (Exception);
118 
119 };
120 
121 } //end of namespace bpp.
122 
123 #endif //_IOSEQUENCEFACTORY_H_
124 
virtual IAlignment * createAlignmentReader(const std::string &format)
Get a new dynamically created IAlignment object.
The OAlignment interface.
Definition: OSequence.h:95
virtual OSequence * createWriter(const std::string &format)
Get a new dynamically created OSequence object.
The OSequence interface.
Definition: OSequence.h:58
static const std::string PAML_FORMAT_INTERLEAVED
static const std::string FASTA_FORMAT
IoSequenceFactory()
Creates a new factory object.
This alphabet is used to deal NumericAlphabet.
static const std::string MASE_FORMAT
static const std::string PAML_FORMAT_SEQUENTIAL
static const std::string PHYLIP_FORMAT_SEQUENTIAL
static const std::string GENBANK_FORMAT
virtual OAlignment * createAlignmentWriter(const std::string &format)
Get a new dynamically created OAlignment object.
static const std::string NEXUS_FORMAT
static const std::string PHYLIP_FORMAT_INTERLEAVED
virtual ISequence * createReader(const std::string &format)
Get a new dynamically created ISequence object.
The IAlignment interface.
Definition: ISequence.h:99
static const std::string CLUSTAL_FORMAT
static const std::string DCSE_FORMAT
Utilitary class for creating sequence readers and writers.
The ISequence interface.
Definition: ISequence.h:64